diff --git a/package-lock.json b/package-lock.json index 52e20629f..353c715d7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -13734,8 +13734,7 @@ "resolved": "https://registry.npmjs.org/openapi-types/-/openapi-types-12.1.3.tgz", "integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw==", "dev": true, - "license": "MIT", - "peer": true + "license": "MIT" }, "node_modules/optionator": { "version": "0.9.4", @@ -18004,7 +18003,8 @@ "@edfi/ed-fi-model-6.1": "3.0.0", "@types/json-stable-stringify": "^1.2.0", "ajv": "^8.12.0", - "ajv-formats": "^2.1.1" + "ajv-formats": "^2.1.1", + "openapi-types": "^12.1.3" } }, "packages/metaed-plugin-edfi-api-schema/node_modules/ajv": { diff --git a/packages/metaed-plugin-edfi-api-schema/package.json b/packages/metaed-plugin-edfi-api-schema/package.json index d0079aded..f034378b7 100644 --- a/packages/metaed-plugin-edfi-api-schema/package.json +++ b/packages/metaed-plugin-edfi-api-schema/package.json @@ -34,7 +34,8 @@ "@edfi/ed-fi-model-6.1": "3.0.0", "@types/json-stable-stringify": "^1.2.0", "ajv": "^8.12.0", - "ajv-formats": "^2.1.1" + "ajv-formats": "^2.1.1", + "openapi-types": "^12.1.3" }, "scripts": { "build": "npm run build:clean && npm run build:copy-non-ts && npm run build:dist", diff --git a/packages/metaed-plugin-edfi-api-schema/src/enhancer/ApiSchemaBuildingEnhancer.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/ApiSchemaBuildingEnhancer.ts index 7b97bea26..c7212a466 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/ApiSchemaBuildingEnhancer.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/ApiSchemaBuildingEnhancer.ts @@ -213,6 +213,7 @@ export function enhance(metaEd: MetaEdEnvironment): EnhancerResult { const resourceNameMapping: ResourceNameMapping = {}; const caseInsensitiveEndpointNameMapping: CaseInsensitiveEndpointNameMapping = {}; const abstractResources: AbstractResourceMapping = {}; + const namespaceEdfiApiSchema: NamespaceEdfiApiSchema = namespace.data.edfiApiSchema as NamespaceEdfiApiSchema; const projectSchema: ProjectSchema = { projectName: namespace.projectName as MetaEdProjectName, @@ -227,11 +228,13 @@ export function enhance(metaEd: MetaEdEnvironment): EnhancerResult { isExtensionProject: namespace.isExtension, educationOrganizationTypes: namespace.data.educationOrganizationTypes as MetaEdResourceName[], educationOrganizationHierarchy: namespace.data.educationOrganizationHierarchy as EducationOrganizationHierarchy, - domains: (namespace.data.edfiApiSchema as NamespaceEdfiApiSchema).domains, - openApiBaseDocuments: (namespace.data.edfiApiSchema as NamespaceEdfiApiSchema).openApiBaseDocuments, + domains: namespaceEdfiApiSchema.domains, + ...(namespace.isExtension || namespaceEdfiApiSchema.openApiBaseDocuments == null + ? {} + : { openApiBaseDocuments: namespaceEdfiApiSchema.openApiBaseDocuments }), }; - const { apiSchema } = namespace.data.edfiApiSchema as NamespaceEdfiApiSchema; + const { apiSchema } = namespaceEdfiApiSchema; apiSchema.projectSchema = projectSchema; getEntitiesOfTypeForNamespaces([namespace], 'domainEntity').forEach((domainEntity) => { diff --git a/packages/metaed-plugin-edfi-api-schema/src/enhancer/EnhancerList.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/EnhancerList.ts index c811fe040..35ba1fb21 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/EnhancerList.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/EnhancerList.ts @@ -21,6 +21,7 @@ import { enhance as mergeCoveringFlattenedIdentityPropertyEnhancer } from './Mer import { enhance as jsonSchemaForInsertEnhancer } from './JsonSchemaForInsertEnhancer'; import { enhance as commonExtensionOverrideCollectorEnhancer } from './CommonExtensionOverrideCollectorEnhancer'; import { enhance as openApiReferenceComponentEnhancer } from './OpenApiReferenceComponentEnhancer'; +import { enhance as openApiTrackedChangeKeyFieldEnhancer } from './OpenApiTrackedChangeKeyFieldEnhancer'; import { enhance as openApiRequestBodyComponentEnhancer } from './OpenApiRequestBodyComponentEnhancer'; import { enhance as openApiRequestBodyCollectionComponentEnhancer } from './OpenApiRequestBodyCollectionComponentEnhancer'; import { enhance as openApiRequestBodyCollectionComponentSubclassEnhancer } from './OpenApiRequestBodyCollectionComponentSubclassEnhancer'; @@ -75,6 +76,7 @@ export function enhancerList(): Enhancer[] { jsonSchemaForInsertEnhancer, commonExtensionOverrideCollectorEnhancer, openApiReferenceComponentEnhancer, + openApiTrackedChangeKeyFieldEnhancer, openApiRequestBodyComponentEnhancer, openApiRequestBodyCollectionComponentEnhancer, openApiRequestBodyCollectionComponentSubclassEnhancer, diff --git a/packages/metaed-plugin-edfi-api-schema/src/enhancer/IdentityJsonPathsEnhancer.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/IdentityJsonPathsEnhancer.ts index 1063fbf78..fedb835e4 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/IdentityJsonPathsEnhancer.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/IdentityJsonPathsEnhancer.ts @@ -36,6 +36,11 @@ export function enhance(metaEd: MetaEdEnvironment): EnhancerResult { (descriptor.data.edfiApiSchema as EntityApiSchemaData).identityJsonPaths = []; }); + // SchoolYearType is modeled by a hard-coded resource schema with schoolYear as its public identity. + getAllEntitiesOfType(metaEd, 'schoolYearEnumeration').forEach((schoolYearEnumeration) => { + (schoolYearEnumeration.data.edfiApiSchema as EntityApiSchemaData).identityJsonPaths = ['$.schoolYear' as JsonPath]; + }); + return { enhancerName: 'IdentityJsonPathsEnhancer', success: true, diff --git a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiBaseDocumentEnhancer.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiBaseDocumentEnhancer.ts index 1af606deb..85fb446d9 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiBaseDocumentEnhancer.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiBaseDocumentEnhancer.ts @@ -4,21 +4,81 @@ // See the LICENSE and NOTICES files in the project root for more information. import { type MetaEdEnvironment, type EnhancerResult, type Namespace } from '@edfi/metaed-core'; -import { ComponentsObject, Document } from '../model/OpenApiTypes'; +import { ComponentsObject, Document, Operation, PathsObject } from '../model/OpenApiTypes'; import { NamespaceEdfiApiSchema } from '../model/Namespace'; import { createHardcodedParameterResponses, createHardcodedComponentParameters } from './OpenApiSpecificationEnhancerBase'; import { newSchoolYearOpenApis } from './OpenApiComponentEnhancerBase'; +import { OpenApiDocumentType, OpenApiDocumentTypeValue } from '../model/api-schema/OpenApiDocumentType'; /** - * Creates the base OpenAPI document structure without paths, schemas, or tags. - * This structure is common to all OpenAPI documents (resources, descriptors, etc.) + * Creates the component object for a document type. */ -function createBaseOpenApiDocument(metaEd: MetaEdEnvironment, documentType: string): Document { - const components: ComponentsObject = { +function createComponentsObject(documentType: OpenApiDocumentTypeValue): ComponentsObject { + if (documentType === OpenApiDocumentType.CHANGE_QUERIES) { + return { + schemas: {}, + responses: {}, + parameters: {}, + }; + } + + return { schemas: {}, responses: createHardcodedParameterResponses(), parameters: createHardcodedComponentParameters(), }; +} + +/** + * Creates the Change Queries available change versions operation. + */ +function createAvailableChangeVersionsOperation(): Operation { + return { + operationId: 'getAvailableChangeVersions', + summary: 'Retrieves the available change version range.', + responses: { + '200': { + description: 'The available change version range was successfully retrieved.', + content: { + 'application/json': { + schema: { + type: 'object', + required: ['oldestChangeVersion', 'newestChangeVersion'], + properties: { + oldestChangeVersion: { + type: 'integer', + format: 'int64', + }, + newestChangeVersion: { + type: 'integer', + format: 'int64', + }, + }, + }, + }, + }, + }, + }, + }; +} + +/** + * Creates the path object for the standalone Change Queries OpenAPI document. + */ +function createChangeQueriesPaths(): PathsObject { + return { + '/availableChangeVersions': { + get: createAvailableChangeVersionsOperation(), + }, + }; +} + +/** + * Creates the base OpenAPI document structure with document-specific initial paths and components. + * This structure is common to all OpenAPI documents (resources, descriptors, etc.) + */ +function createBaseOpenApiDocument(metaEd: MetaEdEnvironment, documentType: OpenApiDocumentTypeValue): Document { + const components: ComponentsObject = createComponentsObject(documentType); const openApiDocument: Document = { openapi: '3.0.0', @@ -34,15 +94,18 @@ function createBaseOpenApiDocument(metaEd: MetaEdEnvironment, documentType: stri url: '', }, ], - paths: {}, + paths: documentType === OpenApiDocumentType.CHANGE_QUERIES ? createChangeQueriesPaths() : {}, components, tags: [], }; // Add hardcoded SchoolYearTypeReference schema only to resources document - if (documentType === 'resources') { + if (documentType === OpenApiDocumentType.RESOURCES) { const schoolYearOpenApis = newSchoolYearOpenApis(metaEd.minSchoolYear, metaEd.maxSchoolYear); - components.schemas!.EdFi_SchoolYearTypeReference = schoolYearOpenApis.schoolYearEnumerationOpenApi; + const { schemas } = components; + if (schemas != null) { + schemas.EdFi_SchoolYearTypeReference = schoolYearOpenApis.schoolYearEnumerationOpenApi; + } } return openApiDocument; @@ -59,10 +122,11 @@ export function enhance(metaEd: MetaEdEnvironment): EnhancerResult { const namespaceEdfiApiSchema: NamespaceEdfiApiSchema = namespace.data.edfiApiSchema as NamespaceEdfiApiSchema; - // Create base documents for resources and descriptors + // Create base documents for resources, descriptors, and the standalone Change Queries fixed route. namespaceEdfiApiSchema.openApiBaseDocuments = { - resources: createBaseOpenApiDocument(metaEd, 'resources'), - descriptors: createBaseOpenApiDocument(metaEd, 'descriptors'), + [OpenApiDocumentType.RESOURCES]: createBaseOpenApiDocument(metaEd, OpenApiDocumentType.RESOURCES), + [OpenApiDocumentType.DESCRIPTORS]: createBaseOpenApiDocument(metaEd, OpenApiDocumentType.DESCRIPTORS), + [OpenApiDocumentType.CHANGE_QUERIES]: createBaseOpenApiDocument(metaEd, OpenApiDocumentType.CHANGE_QUERIES), }; }); diff --git a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts new file mode 100644 index 000000000..5aed8fbab --- /dev/null +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiChangeQuerySchemaBuilder.ts @@ -0,0 +1,217 @@ +// 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 DomainEntity, type TopLevelEntity } from '@edfi/metaed-core'; +import { invariant } from 'ts-invariant'; +import type { EntityApiSchemaData } from '../model/EntityApiSchemaData'; +import type { SchemaObject, Schemas } from '../model/OpenApiTypes'; +import type { TrackedChangeKeyField } from '../model/TrackedChangeKeyField'; +import { deAcronym, normalizeDescriptorName } from '../Utility'; +import { schemaObjectFromEntityProperty } from './OpenApiEntityPropertySchemaMapper'; + +/** + * Component schema names used by tracked-change OpenAPI response schemas. + */ +export type TrackedChangeSchemaNames = { + keyValues: string; + deleteItem: string; + keyChangeItem: string; +}; + +/** + * A public query field and OpenAPI schema pair derived from identity metadata. + */ +type IdentityFieldSchema = { + fieldName: string; + schema: SchemaObject; +}; + +/** + * Creates a display name for tracked-change invariant messages. + */ +function entityDisplayNameFor(entity: TopLevelEntity): string { + return `${entity.namespace.namespaceName}.${entity.metaEdName}`; +} + +/** + * Creates the tracked-change component base name for an entity. + */ +function trackedChangeComponentBaseNameFor(entity: TopLevelEntity): string { + return `${deAcronym(entity.namespace.namespaceName)}_${deAcronym(normalizeDescriptorName(entity))}`; +} + +/** + * Creates tracked-change component schema names for an entity. + */ +export function trackedChangeSchemaNamesFor(entity: TopLevelEntity): TrackedChangeSchemaNames { + const componentBaseName: string = trackedChangeComponentBaseNameFor(entity); + + return { + keyValues: `${componentBaseName}_TrackedChangeKey`, + deleteItem: `${componentBaseName}_TrackedChangeDelete`, + keyChangeItem: `${componentBaseName}_TrackedChangeKeyChange`, + }; +} + +/** + * Returns whether the entity is an abstract resource with schemas but no endpoint. + */ +function isAbstractResource(entity: TopLevelEntity): boolean { + return ( + (entity.type === 'domainEntity' || + entity.type === 'association' || + entity.type === 'domainEntitySubclass' || + entity.type === 'associationSubclass') && + (entity as DomainEntity).isAbstract === true + ); +} + +/** + * Asserts that a concrete resource has complete semantic metadata for tracked-change key schemas. + */ +function assertCanCreateIdentityFieldSchemasFrom( + entity: TopLevelEntity, + trackedChangeKeyFields: TrackedChangeKeyField[], +): void { + invariant( + trackedChangeKeyFields.length > 0, + `Unable to create tracked-change key schema for ${entityDisplayNameFor( + entity, + )}. No tracked-change key fields were found.`, + ); +} + +/** + * Creates an OpenAPI schema object from a tracked-change key field. + */ +function identityFieldSchemaFrom(trackedChangeKeyField: TrackedChangeKeyField): IdentityFieldSchema { + return { + fieldName: trackedChangeKeyField.fieldName, + schema: schemaObjectFromEntityProperty(trackedChangeKeyField.sourceProperty, { type: 'string' }), + }; +} + +/** + * Creates public identity field schemas for a regular resource from tracked-change key field metadata. + */ +function identityFieldSchemasFrom(entity: TopLevelEntity): IdentityFieldSchema[] { + const entityApiSchemaData: EntityApiSchemaData = entity.data.edfiApiSchema as EntityApiSchemaData; + const trackedChangeKeyFields: TrackedChangeKeyField[] = entityApiSchemaData.trackedChangeKeyFields ?? []; + + assertCanCreateIdentityFieldSchemasFrom(entity, trackedChangeKeyFields); + + return trackedChangeKeyFields.map((trackedChangeKeyField: TrackedChangeKeyField) => + identityFieldSchemaFrom(trackedChangeKeyField), + ); +} + +/** + * Creates the descriptor tracked-change key schema. + */ +function descriptorKeyValuesSchema(): SchemaObject { + return { + type: 'object', + required: ['namespace', 'codeValue'], + properties: { + namespace: { + type: 'string', + maxLength: 255, + }, + codeValue: { + type: 'string', + maxLength: 50, + }, + }, + }; +} + +/** + * Creates the tracked-change key object schema from identity field schemas. + */ +function keyValuesSchemaFrom(identityFieldSchemas: IdentityFieldSchema[]): SchemaObject { + const properties: { [name: string]: SchemaObject } = {}; + const required: string[] = []; + + identityFieldSchemas.forEach((identityFieldSchema: IdentityFieldSchema) => { + properties[identityFieldSchema.fieldName] = identityFieldSchema.schema; + required.push(identityFieldSchema.fieldName); + }); + + const sortedRequired: string[] = [...required].sort(); + + return { + type: 'object', + required: sortedRequired, + properties, + }; +} + +/** + * Creates the shared tracked-change ChangeVersion schema. + */ +function changeVersionSchema(): SchemaObject { + return { + type: 'integer', + format: 'int64', + }; +} + +/** + * Creates the tracked-change delete response item schema. + */ +function deleteItemSchema(keyValuesSchemaName: string): SchemaObject { + return { + type: 'object', + required: ['id', 'changeVersion', 'keyValues'], + properties: { + id: { + type: 'string', + }, + changeVersion: changeVersionSchema(), + keyValues: { + $ref: `#/components/schemas/${keyValuesSchemaName}`, + }, + }, + }; +} + +/** + * Creates the tracked-change key-change response item schema. + */ +function keyChangeItemSchema(keyValuesSchemaName: string): SchemaObject { + return { + type: 'object', + required: ['id', 'changeVersion', 'oldKeyValues', 'newKeyValues'], + properties: { + id: { + type: 'string', + }, + changeVersion: changeVersionSchema(), + oldKeyValues: { + $ref: `#/components/schemas/${keyValuesSchemaName}`, + }, + newKeyValues: { + $ref: `#/components/schemas/${keyValuesSchemaName}`, + }, + }, + }; +} + +/** + * Creates tracked-change OpenAPI component schemas for a resource or descriptor. + */ +export function createTrackedChangeSchemasFrom(entity: TopLevelEntity): Schemas { + if (isAbstractResource(entity)) return {}; + + const trackedChangeSchemaNames: TrackedChangeSchemaNames = trackedChangeSchemaNamesFor(entity); + const keyValuesSchema: SchemaObject = + entity.type === 'descriptor' ? descriptorKeyValuesSchema() : keyValuesSchemaFrom(identityFieldSchemasFrom(entity)); + + return { + [trackedChangeSchemaNames.keyValues]: keyValuesSchema, + [trackedChangeSchemaNames.deleteItem]: deleteItemSchema(trackedChangeSchemaNames.keyValues), + [trackedChangeSchemaNames.keyChangeItem]: keyChangeItemSchema(trackedChangeSchemaNames.keyValues), + }; +} diff --git a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiEntityPropertySchemaMapper.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiEntityPropertySchemaMapper.ts new file mode 100644 index 000000000..3461f161a --- /dev/null +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiEntityPropertySchemaMapper.ts @@ -0,0 +1,66 @@ +// 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 EntityProperty, type IntegerProperty, type StringProperty } from '@edfi/metaed-core'; +import type { SchemaObject } from '../model/OpenApiTypes'; + +/** + * Returns an OpenAPI schema object corresponding to the given scalar property based on its semantic type. + */ +export function schemaObjectFromEntityProperty( + property: EntityProperty, + unsupportedPropertySchema: SchemaObject = { type: 'boolean' }, +): SchemaObject { + switch (property.type) { + case 'boolean': + return { type: 'boolean' }; + + case 'duration': + return { type: 'string', maxLength: 30 }; + + case 'currency': + case 'decimal': + case 'percent': + case 'sharedDecimal': + return { type: 'number', format: 'double' }; + + case 'date': + return { type: 'string', format: 'date' }; + + case 'datetime': + return { type: 'string', format: 'date-time' }; + + case 'descriptor': + case 'enumeration': + return { type: 'string', maxLength: 306 }; + + case 'integer': + case 'sharedInteger': { + const integerProperty: IntegerProperty = property as IntegerProperty; + return { type: 'integer', format: integerProperty.hasBigHint ? 'int64' : 'int32' }; + } + + case 'short': + case 'sharedShort': + case 'schoolYearEnumeration': + case 'year': + return { type: 'integer', format: 'int32' }; + + case 'string': + case 'sharedString': { + const result: SchemaObject = { type: 'string' }; + const stringProperty: StringProperty = property as StringProperty; + if (stringProperty.minLength) result.minLength = Number(stringProperty.minLength); + if (stringProperty.maxLength) result.maxLength = Number(stringProperty.maxLength); + return result; + } + + case 'time': + return { type: 'string' }; + + default: + return unsupportedPropertySchema; + } +} diff --git a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiResourceFragmentEnhancer.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiResourceFragmentEnhancer.ts index 7ce40c234..4a5cdd2b6 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiResourceFragmentEnhancer.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiResourceFragmentEnhancer.ts @@ -17,14 +17,20 @@ import { createSchemasFrom, createPathsFrom, createTagsFrom } from './OpenApiSpe import { OpenApiFragment } from '../model/api-schema/OpenApiFragment'; import { newSchoolYearOpenApis, SchoolYearOpenApis } from './OpenApiComponentEnhancerBase'; import { deAcronym } from '../Utility'; +import { createTrackedChangeSchemasFrom } from './OpenApiChangeQuerySchemaBuilder'; +import { Schemas } from '../model/OpenApiTypes'; /** * Creates an OpenAPI fragment for a resource entity */ export function createResourceFragment(entity: TopLevelEntity): OpenApiFragment { + const trackedChangeSchemas: Schemas = createTrackedChangeSchemasFrom(entity); const fragment: OpenApiFragment = { components: { - schemas: createSchemasFrom(entity), + schemas: { + ...createSchemasFrom(entity), + ...trackedChangeSchemas, + }, }, }; @@ -42,10 +48,15 @@ export function createResourceFragment(entity: TopLevelEntity): OpenApiFragment * Creates an OpenAPI fragment for a descriptor entity */ function createDescriptorFragment(entity: TopLevelEntity): OpenApiFragment { + const trackedChangeSchemas: Schemas = createTrackedChangeSchemasFrom(entity); + return { paths: createPathsFrom(entity), components: { - schemas: createSchemasFrom(entity), + schemas: { + ...createSchemasFrom(entity), + ...trackedChangeSchemas, + }, }, tags: createTagsFrom(entity), }; diff --git a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiSpecificationEnhancerBase.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiSpecificationEnhancerBase.ts index d1370d4da..4bd14e705 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiSpecificationEnhancerBase.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiSpecificationEnhancerBase.ts @@ -4,13 +4,12 @@ // See the LICENSE and NOTICES files in the project root for more information. import { invariant } from 'ts-invariant'; -import { type TopLevelEntity, EntityProperty, StringProperty, IntegerProperty } from '@edfi/metaed-core'; +import { type TopLevelEntity } from '@edfi/metaed-core'; import type { EntityApiSchemaData } from '../model/EntityApiSchemaData'; import type { EndpointName } from '../model/api-schema/EndpointName'; import { Operation, Parameter, - SchemaObject, ResponsesObject, ParameterObject, ReferenceObject, @@ -21,6 +20,8 @@ import { import { pluralize, deAcronym, createUriSegment } from '../Utility'; import { ProjectEndpointName } from '../model/api-schema/ProjectEndpointName'; import { normalizeDescriptorName } from '../Utility'; +import { type TrackedChangeSchemaNames, trackedChangeSchemaNamesFor } from './OpenApiChangeQuerySchemaBuilder'; +import { schemaObjectFromEntityProperty } from './OpenApiEntityPropertySchemaMapper'; /** * Creates the set of hardcoded component parameters @@ -59,10 +60,6 @@ export function createHardcodedParameterResponses(): ResponsesObject { NotFound: { description: 'The resource could not be found.', }, - NotFoundUseSnapshot: { - description: - 'The resource could not be found. If Use-Snapshot header is set to true, this response can indicate the snapshot may have been removed.', - }, Conflict: { description: 'Conflict. The request cannot be completed because it would result in an invalid state. See the response body for details.', @@ -114,6 +111,7 @@ export function createHardcodedComponentParameters(): { [key: string]: Reference in: 'query', description: 'Used in synchronization to set sequence minimum ChangeVersion', schema: { + minimum: 0, type: 'integer', format: 'int64', }, @@ -123,6 +121,7 @@ export function createHardcodedComponentParameters(): { [key: string]: Reference in: 'query', description: 'Used in synchronization to set sequence maximum ChangeVersion', schema: { + minimum: 0, type: 'integer', format: 'int64', }, @@ -248,7 +247,7 @@ export function createPostSectionFor(entity: TopLevelEntity, endpointName: Endpo $ref: '#/components/responses/Forbidden', }, '405': { - description: 'Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed.', + description: 'Method Is Not Allowed.', }, '409': { $ref: '#/components/responses/Conflict', @@ -323,59 +322,26 @@ function newStaticUpdateByIdParameters(): Parameter[] { } /** - * Returns an OpenAPI schema object corresponding to the given property based on its type. + * Returns the hardcoded query parameters for Change Query tracked-change paths. */ -function schemaObjectFrom(property: EntityProperty): SchemaObject { - switch (property.type) { - case 'boolean': - return { type: 'boolean' }; - - case 'duration': - return { type: 'string', maxLength: 30 }; - - case 'currency': - case 'decimal': - case 'percent': - case 'sharedDecimal': - return { type: 'number', format: 'double' }; - - case 'date': - return { type: 'string', format: 'date' }; - - case 'datetime': - return { type: 'string', format: 'date-time' }; - - case 'descriptor': - case 'enumeration': - return { type: 'string', maxLength: 306 }; - - case 'integer': - case 'sharedInteger': { - const integerProperty: IntegerProperty = property as IntegerProperty; - return { type: 'integer', format: integerProperty.hasBigHint ? 'int64' : 'int32' }; - } - - case 'short': - case 'sharedShort': - case 'schoolYearEnumeration': - case 'year': - return { type: 'integer', format: 'int32' }; - - case 'string': - case 'sharedString': { - const result: SchemaObject = { type: 'string' }; - const stringProperty: StringProperty = property as StringProperty; - if (stringProperty.minLength) result.minLength = Number(stringProperty.minLength); - if (stringProperty.maxLength) result.maxLength = Number(stringProperty.maxLength); - return result; - } - - case 'time': - return { type: 'string' }; - - default: - return { type: 'boolean' }; - } +function newStaticTrackedChangeQueryParameters(): Parameter[] { + return [ + { + $ref: '#/components/parameters/MinChangeVersion', + }, + { + $ref: '#/components/parameters/MaxChangeVersion', + }, + { + $ref: '#/components/parameters/limit', + }, + { + $ref: '#/components/parameters/offset', + }, + { + $ref: '#/components/parameters/totalCount', + }, + ]; } // All descriptor documents have the same OpenAPI get by query parameters @@ -469,7 +435,7 @@ function getByQueryParametersFor(entity: TopLevelEntity): Parameter[] { name: fieldName, in: 'query', description: sourceProperty.documentation, - schema: schemaObjectFrom(sourceProperty), + schema: schemaObjectFromEntityProperty(sourceProperty), ...(sourceProperty.isPartOfIdentity && { 'x-Ed-Fi-isIdentity': true }), }; @@ -517,7 +483,7 @@ export function createGetByQuerySectionFor(entity: TopLevelEntity, endpointName: $ref: '#/components/responses/Forbidden', }, '404': { - $ref: '#/components/responses/NotFoundUseSnapshot', + $ref: '#/components/responses/NotFound', }, '500': { $ref: '#/components/responses/Error', @@ -536,18 +502,7 @@ export function createGetByIdSectionFor(entity: TopLevelEntity, endpointName: En return { description: 'This GET operation retrieves a resource by the specified resource identifier.', operationId: `get${extensionPrefix}${pluralize(entity.metaEdName)}ById`, - parameters: [ - ...newStaticGetByIdParameters(), - { - name: 'Use-Snapshot', - in: 'header', - description: 'Indicates if the configured Snapshot should be used.', - schema: { - type: 'boolean', - default: false, - }, - }, - ], + parameters: newStaticGetByIdParameters(), responses: { '200': { description: 'The requested resource was successfully retrieved.', @@ -574,7 +529,7 @@ export function createGetByIdSectionFor(entity: TopLevelEntity, endpointName: En $ref: '#/components/responses/Forbidden', }, '404': { - $ref: '#/components/responses/NotFoundUseSnapshot', + $ref: '#/components/responses/NotFound', }, '500': { $ref: '#/components/responses/Error', @@ -585,6 +540,76 @@ export function createGetByIdSectionFor(entity: TopLevelEntity, endpointName: En }; } +/** + * Creates the standard response object for Change Query tracked-change operations. + */ +function createTrackedChangeResponsesFor(trackedChangeItemSchemaName: string): ResponsesObject { + return { + '200': { + description: 'The requested Change Query results were successfully retrieved.', + content: { + 'application/json': { + schema: { + type: 'array', + items: { + $ref: `#/components/schemas/${trackedChangeItemSchemaName}`, + }, + }, + }, + }, + }, + '400': { + $ref: '#/components/responses/BadRequest', + }, + '401': { + $ref: '#/components/responses/Unauthorized', + }, + '403': { + $ref: '#/components/responses/Forbidden', + }, + '404': { + $ref: '#/components/responses/NotFound', + }, + '500': { + $ref: '#/components/responses/Error', + }, + }; +} + +/** + * Returns the "get" section of the tracked-change deletes path for the given entity. + */ +export function createTrackedChangeDeletesSectionFor(entity: TopLevelEntity, endpointName: EndpointName): Operation { + const extensionPrefix: string = entity.namespace.isExtension ? `_${entity.namespace.namespaceName}` : ''; + const trackedChangeSchemaNames: TrackedChangeSchemaNames = trackedChangeSchemaNamesFor(entity); + + return { + description: 'This GET operation provides access to deleted resource keys in the requested ChangeVersion range.', + operationId: `get${extensionPrefix}${pluralize(entity.metaEdName)}Deletes`, + parameters: newStaticTrackedChangeQueryParameters(), + responses: createTrackedChangeResponsesFor(trackedChangeSchemaNames.deleteItem), + summary: 'Retrieves deleted resource keys for Change Queries.', + tags: [endpointName], + }; +} + +/** + * Returns the "get" section of the tracked-change key changes path for the given entity. + */ +export function createTrackedChangeKeyChangesSectionFor(entity: TopLevelEntity, endpointName: EndpointName): Operation { + const extensionPrefix: string = entity.namespace.isExtension ? `_${entity.namespace.namespaceName}` : ''; + const trackedChangeSchemaNames: TrackedChangeSchemaNames = trackedChangeSchemaNamesFor(entity); + + return { + description: 'This GET operation provides access to changed resource keys in the requested ChangeVersion range.', + operationId: `get${extensionPrefix}${pluralize(entity.metaEdName)}KeyChanges`, + parameters: newStaticTrackedChangeQueryParameters(), + responses: createTrackedChangeResponsesFor(trackedChangeSchemaNames.keyChangeItem), + summary: 'Retrieves changed resource keys for Change Queries.', + tags: [endpointName], + }; +} + /** * Returns the "put" section of id "path" for the given entity */ @@ -626,7 +651,7 @@ export function createPutSectionFor(entity: TopLevelEntity, endpointName: Endpoi $ref: '#/components/responses/NotFound', }, '405': { - description: 'Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed.', + description: 'Method Is Not Allowed.', }, '409': { $ref: '#/components/responses/Conflict', @@ -671,7 +696,7 @@ export function createDeleteSectionFor(entity: TopLevelEntity, endpointName: End $ref: '#/components/responses/NotFound', }, '405': { - description: 'Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed.', + description: 'Method Is Not Allowed.', }, '409': { $ref: '#/components/responses/Conflict', @@ -735,15 +760,26 @@ export function createPathsFrom(entity: TopLevelEntity): PathsObject { const projectEndpointName: ProjectEndpointName = createUriSegment(entity.namespace.projectName) as ProjectEndpointName; const { endpointName, domains } = entity.data.edfiApiSchema as EntityApiSchemaData; + const resourcePath: string = `/${projectEndpointName}/${endpointName}`; // Add to paths without "id" - paths[`/${projectEndpointName}/${endpointName}`] = { + paths[resourcePath] = { post: createPostSectionFor(entity, endpointName), get: createGetByQuerySectionFor(entity, endpointName), 'x-Ed-Fi-domains': domains, }; - paths[`/${projectEndpointName}/${endpointName}/{id}`] = { + paths[`${resourcePath}/deletes`] = { + get: createTrackedChangeDeletesSectionFor(entity, endpointName), + 'x-Ed-Fi-domains': domains, + }; + + paths[`${resourcePath}/keyChanges`] = { + get: createTrackedChangeKeyChangesSectionFor(entity, endpointName), + 'x-Ed-Fi-domains': domains, + }; + + paths[`${resourcePath}/{id}`] = { get: createGetByIdSectionFor(entity, endpointName), put: createPutSectionFor(entity, endpointName), delete: createDeleteSectionFor(entity, endpointName), diff --git a/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.ts new file mode 100644 index 000000000..ac2141904 --- /dev/null +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.ts @@ -0,0 +1,153 @@ +// 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 EntityProperty, + type EnhancerResult, + type MetaEdEnvironment, + type TopLevelEntity, + getAllEntitiesOfType, + newEntityProperty, +} from '@edfi/metaed-core'; +import { invariant } from 'ts-invariant'; +import type { EntityApiSchemaData } from '../model/EntityApiSchemaData'; +import type { EntityPropertyApiSchemaData } from '../model/EntityPropertyApiSchemaData'; +import type { FlattenedIdentityProperty } from '../model/FlattenedIdentityProperty'; +import type { SchemaObject } from '../model/OpenApiTypes'; +import { defaultPropertyModifier, prefixedName } from '../model/PropertyModifier'; +import type { TrackedChangeKeyField, TrackedChangeKeyFieldName } from '../model/TrackedChangeKeyField'; +import { findIdenticalRoleNamePatternPrefix, prependPrefixWithCollapse, uncapitalize } from '../Utility'; +import { parentPropertyModifier } from './JsonElementNamingHelper'; +import { schemaObjectFromEntityProperty } from './OpenApiEntityPropertySchemaMapper'; + +const enhancerName = 'OpenApiTrackedChangeKeyFieldEnhancer'; + +/** + * Creates a display name for tracked-change invariant messages. + */ +function entityDisplayNameFor(entity: TopLevelEntity): string { + return `${entity.namespace.namespaceName}.${entity.metaEdName}`; +} + +/** + * Returns the public tracked-change key field name for a flattened identity property. + */ +function trackedChangeKeyFieldNameFrom(flattenedIdentityProperty: FlattenedIdentityProperty): TrackedChangeKeyFieldName { + const identityPropertyApiMapping = ( + flattenedIdentityProperty.identityProperty.data.edfiApiSchema as EntityPropertyApiSchemaData + ).apiMapping; + + const specialPrefix: string = findIdenticalRoleNamePatternPrefix(flattenedIdentityProperty); + const adjustedName: string = + specialPrefix === '' + ? identityPropertyApiMapping.fullName + : prependPrefixWithCollapse(identityPropertyApiMapping.fullName, specialPrefix); + const parentAdjustedPropertyModifier = parentPropertyModifier(flattenedIdentityProperty, defaultPropertyModifier); + + return uncapitalize(prefixedName(adjustedName, parentAdjustedPropertyModifier)) as TrackedChangeKeyFieldName; +} + +/** + * Returns whether the tracked-change key field source properties produce the same OpenAPI schema. + */ +function trackedChangeKeyFieldSchemasMatch( + trackedChangeKeyField: TrackedChangeKeyField, + sourceProperty: EntityProperty, +): boolean { + const existingSchema: SchemaObject = schemaObjectFromEntityProperty(trackedChangeKeyField.sourceProperty, { + type: 'string', + }); + const newSchema: SchemaObject = schemaObjectFromEntityProperty(sourceProperty, { type: 'string' }); + + return ( + existingSchema.type === newSchema.type && + existingSchema.format === newSchema.format && + existingSchema.maxLength === newSchema.maxLength && + existingSchema.minLength === newSchema.minLength + ); +} + +/** + * Adds a tracked-change key field to the collection, failing on ambiguous public field names. + */ +function addTrackedChangeKeyField( + trackedChangeKeyFieldsByName: { [fieldName: string]: TrackedChangeKeyField }, + entity: TopLevelEntity, + fieldName: TrackedChangeKeyFieldName, + sourceProperty: EntityProperty, +): void { + const existingTrackedChangeKeyField: TrackedChangeKeyField | undefined = trackedChangeKeyFieldsByName[fieldName]; + + if (existingTrackedChangeKeyField != null) { + invariant( + trackedChangeKeyFieldSchemasMatch(existingTrackedChangeKeyField, sourceProperty), + `Tracked-change key field name collision for ${entityDisplayNameFor( + entity, + )}: ${fieldName} is produced by multiple non-merged-away identity properties with different schemas.`, + ); + return; + } + + trackedChangeKeyFieldsByName[fieldName] = { + fieldName, + sourceProperty, + }; +} + +/** + * Returns the public tracked-change key fields for a regular resource entity. + */ +function trackedChangeKeyFieldsFrom(entity: TopLevelEntity): TrackedChangeKeyField[] { + const entityApiSchemaData: EntityApiSchemaData = entity.data.edfiApiSchema as EntityApiSchemaData; + const trackedChangeKeyFieldsByName: { [fieldName: string]: TrackedChangeKeyField } = {}; + + entityApiSchemaData.apiMapping.flattenedIdentityProperties + .filter((flattenedIdentityProperty: FlattenedIdentityProperty) => flattenedIdentityProperty.mergedAwayBy == null) + .forEach((flattenedIdentityProperty: FlattenedIdentityProperty) => { + const fieldName: TrackedChangeKeyFieldName = trackedChangeKeyFieldNameFrom(flattenedIdentityProperty); + addTrackedChangeKeyField(trackedChangeKeyFieldsByName, entity, fieldName, flattenedIdentityProperty.identityProperty); + }); + + return Object.values(trackedChangeKeyFieldsByName); +} + +/** + * Returns the public tracked-change key fields for the hard-coded SchoolYear resource. + */ +function schoolYearTrackedChangeKeyFields(): TrackedChangeKeyField[] { + const schoolYearSourceProperty: EntityProperty = { + ...newEntityProperty(), + type: 'schoolYearEnumeration', + }; + + return [ + { + fieldName: 'schoolYear' as TrackedChangeKeyFieldName, + sourceProperty: schoolYearSourceProperty, + }, + ]; +} + +/** + * Adds public tracked-change key fields to resource entity data. + */ +export function enhance(metaEd: MetaEdEnvironment): EnhancerResult { + getAllEntitiesOfType(metaEd, 'domainEntity', 'association', 'domainEntitySubclass', 'associationSubclass').forEach( + (entity) => { + (entity.data.edfiApiSchema as EntityApiSchemaData).trackedChangeKeyFields = trackedChangeKeyFieldsFrom( + entity as TopLevelEntity, + ); + }, + ); + + getAllEntitiesOfType(metaEd, 'schoolYearEnumeration').forEach((entity) => { + (entity.data.edfiApiSchema as EntityApiSchemaData).trackedChangeKeyFields = schoolYearTrackedChangeKeyFields(); + }); + + return { + enhancerName, + success: true, + }; +} diff --git a/packages/metaed-plugin-edfi-api-schema/src/enhancer/SchoolYearHardCodedSchemaBuilder.ts b/packages/metaed-plugin-edfi-api-schema/src/enhancer/SchoolYearHardCodedSchemaBuilder.ts index b70ba36b4..e18b15551 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/enhancer/SchoolYearHardCodedSchemaBuilder.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/enhancer/SchoolYearHardCodedSchemaBuilder.ts @@ -61,6 +61,7 @@ export function buildSchoolYearResourceSchema( const endpointName: EndpointName = 'schoolYearTypes' as EndpointName; const lowerCasedEndpointName: EndpointName = 'schoolyeartypes' as EndpointName; const documentObjectPaths = ['schoolYear', 'currentSchoolYear', 'schoolYearDescription']; + const entityApiSchemaData: EntityApiSchemaData = schoolYearEnumeration.data.edfiApiSchema as EntityApiSchemaData; resourceNameMapping[metaEdResourceName] = endpointName; caseInsensitiveEndpointNameMapping[lowerCasedEndpointName] = endpointName; @@ -96,7 +97,7 @@ export function buildSchoolYearResourceSchema( type: 'object', }, equalityConstraints: [], - identityJsonPaths: ['$.schoolYear'] as JsonPath[], + identityJsonPaths: entityApiSchemaData.identityJsonPaths, booleanJsonPaths: ['$.currentSchoolYear'] as JsonPath[], numericJsonPaths: ['$.schoolYear'] as JsonPath[], dateJsonPaths: [] as JsonPath[], @@ -105,9 +106,7 @@ export function buildSchoolYearResourceSchema( isSubclass: false, isResourceExtension: false, documentPathsMapping: buildDocumentPathsMapping(documentObjectPaths), - queryFieldMapping: removeSourcePropertyFromQueryFieldMapping( - (schoolYearEnumeration.data.edfiApiSchema as EntityApiSchemaData).queryFieldMapping, - ), + queryFieldMapping: removeSourcePropertyFromQueryFieldMapping(entityApiSchemaData.queryFieldMapping), securableElements: { Namespace: [], EducationOrganization: [], Student: [], Contact: [], Staff: [] }, authorizationPathways: [], arrayUniquenessConstraints: [], diff --git a/packages/metaed-plugin-edfi-api-schema/src/model/EntityApiSchemaData.ts b/packages/metaed-plugin-edfi-api-schema/src/model/EntityApiSchemaData.ts index 01b421be3..9e05c5bac 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/model/EntityApiSchemaData.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/model/EntityApiSchemaData.ts @@ -35,6 +35,7 @@ import { RelationalTableNode } from './relational/RelationalTableNode'; import { RelationalNamingPlan } from './relational/RelationalNamingPlan'; import { RelationalNameOverrides } from './relational/RelationalNameOverrides'; import { CommonExtensionOverride } from './api-schema/CommonExtensionOverride'; +import { TrackedChangeKeyField } from './TrackedChangeKeyField'; export type EntityApiSchemaData = { /** @@ -150,6 +151,11 @@ export type EntityApiSchemaData = { */ identityJsonPaths: JsonPath[]; + /** + * Public key fields used by tracked-change OpenAPI response schemas. + */ + trackedChangeKeyFields: TrackedChangeKeyField[]; + /** * A list of the JsonPaths that are of type boolean for use in type coercion. */ @@ -284,6 +290,8 @@ export function addEntityApiSchemaDataTo(entity: ModelBase) { endpointName: '' as EndpointName, resourceName: '' as MetaEdResourceName, identityFullnames: [], + identityJsonPaths: [], + trackedChangeKeyFields: [], queryFieldMapping: {}, namespaceSecurableElements: [], educationOrganizationSecurableElements: [], diff --git a/packages/metaed-plugin-edfi-api-schema/src/model/Namespace.ts b/packages/metaed-plugin-edfi-api-schema/src/model/Namespace.ts index 914115bf6..4eb57cc35 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/model/Namespace.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/model/Namespace.ts @@ -9,9 +9,23 @@ import { type Document } from './OpenApiTypes'; import { DomainName } from './api-schema/DomainName'; import { OpenApiDocumentTypeValue } from './api-schema/OpenApiDocumentType'; +/** + * API Schema data accumulated on a MetaEd namespace by the API Schema plugin. + */ export type NamespaceEdfiApiSchema = { + /** + * The ApiSchema document generated for this namespace. + */ apiSchema: ApiSchema; + + /** + * Domain names defined by this namespace. + */ domains: DomainName[]; + + /** + * Core-only OpenAPI base documents keyed by document type. + */ openApiBaseDocuments?: { [documentType in OpenApiDocumentTypeValue]?: Document; }; @@ -19,7 +33,7 @@ export type NamespaceEdfiApiSchema = { const enhancerName = 'NamespaceSetupEnhancer'; -export function addNamespaceEdfiApiSchema(namespace: Namespace) { +export function addNamespaceEdfiApiSchema(namespace: Namespace): void { if (namespace.data.edfiApiSchema == null) namespace.data.edfiApiSchema = {}; Object.assign(namespace.data.edfiApiSchema, { diff --git a/packages/metaed-plugin-edfi-api-schema/src/model/TrackedChangeKeyField.ts b/packages/metaed-plugin-edfi-api-schema/src/model/TrackedChangeKeyField.ts new file mode 100644 index 000000000..94b6e2fa1 --- /dev/null +++ b/packages/metaed-plugin-edfi-api-schema/src/model/TrackedChangeKeyField.ts @@ -0,0 +1,19 @@ +// 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 { BrandType, EntityProperty } from '@edfi/metaed-core'; + +/** + * A string type branded as a tracked-change key field name, which is the public field name used in OpenAPI key schemas. + */ +export type TrackedChangeKeyFieldName = BrandType; + +/** + * A public tracked-change key field derived from semantic identity metadata. + */ +export type TrackedChangeKeyField = { + fieldName: TrackedChangeKeyFieldName; + sourceProperty: EntityProperty; +}; diff --git a/packages/metaed-plugin-edfi-api-schema/src/model/api-schema/OpenApiDocumentType.ts b/packages/metaed-plugin-edfi-api-schema/src/model/api-schema/OpenApiDocumentType.ts index 3d8653124..96650a1c0 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/model/api-schema/OpenApiDocumentType.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/model/api-schema/OpenApiDocumentType.ts @@ -9,6 +9,10 @@ export const OpenApiDocumentType = { RESOURCES: 'resources', DESCRIPTORS: 'descriptors', + CHANGE_QUERIES: 'changeQueries', } as const; +/** + * String values identifying the supported OpenAPI base document and fragment types. + */ export type OpenApiDocumentTypeValue = typeof OpenApiDocumentType[keyof typeof OpenApiDocumentType]; diff --git a/packages/metaed-plugin-edfi-api-schema/src/model/api-schema/ProjectSchema.ts b/packages/metaed-plugin-edfi-api-schema/src/model/api-schema/ProjectSchema.ts index 6ea7e47fb..e38e30b87 100644 --- a/packages/metaed-plugin-edfi-api-schema/src/model/api-schema/ProjectSchema.ts +++ b/packages/metaed-plugin-edfi-api-schema/src/model/api-schema/ProjectSchema.ts @@ -98,7 +98,7 @@ export type BaseProjectSchema = { isExtensionProject: boolean; /** - * Base OpenAPI documents for each document type (only for core projects) + * Base OpenAPI documents for each document type, emitted only for core projects. */ openApiBaseDocuments?: { [documentType in OpenApiDocumentTypeValue]?: Document; diff --git a/packages/metaed-plugin-edfi-api-schema/test/enhancer/ApiSchemaBuildingEnhancer.test.ts b/packages/metaed-plugin-edfi-api-schema/test/enhancer/ApiSchemaBuildingEnhancer.test.ts index 58525b53b..bb4e91765 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/enhancer/ApiSchemaBuildingEnhancer.test.ts +++ b/packages/metaed-plugin-edfi-api-schema/test/enhancer/ApiSchemaBuildingEnhancer.test.ts @@ -50,10 +50,16 @@ import { enhance as mergeDirectiveEqualityConstraintEnhancer } from '../../src/e import { enhance as resourceNameEnhancer } from '../../src/enhancer/ResourceNameEnhancer'; import { enhance as identityFullnameEnhancer } from '../../src/enhancer/IdentityFullnameEnhancer'; import { enhance as subclassIdentityFullnameEnhancer } from '../../src/enhancer/SubclassIdentityFullnameEnhancer'; +import { enhance as queryFieldMappingEnhancer } from '../../src/enhancer/QueryFieldMappingEnhancer'; import { enhance as identityJsonPathsEnhancer } from '../../src/enhancer/IdentityJsonPathsEnhancer'; import { enhance as documentPathsMappingEnhancer } from '../../src/enhancer/DocumentPathsMappingEnhancer'; import { enhance as typeCoercionJsonPathsEnhancer } from '../../src/enhancer/TypeCoercionJsonPathsEnhancer'; import { enhance, removeSourcePropertyFromDocumentPathsMapping } from '../../src/enhancer/ApiSchemaBuildingEnhancer'; +import { enhance as openApiTrackedChangeKeyFieldEnhancer } from '../../src/enhancer/OpenApiTrackedChangeKeyFieldEnhancer'; +import { enhance as openApiBaseDocumentEnhancer } from '../../src/enhancer/OpenApiBaseDocumentEnhancer'; +import { NamespaceEdfiApiSchema } from '../../src/model/Namespace'; +import { OpenApiDocumentType } from '../../src/model/api-schema/OpenApiDocumentType'; +import { type Document } from '../../src/model/OpenApiTypes'; const ajv = new Ajv({ allErrors: true }); addFormatsTo(ajv as unknown as Parameters[0]); @@ -76,8 +82,10 @@ function runApiSchemaEnhancers(metaEd: MetaEdEnvironment) { documentPathsMappingEnhancer(metaEd); identityFullnameEnhancer(metaEd); subclassIdentityFullnameEnhancer(metaEd); + queryFieldMappingEnhancer(metaEd); identityJsonPathsEnhancer(metaEd); typeCoercionJsonPathsEnhancer(metaEd); + openApiTrackedChangeKeyFieldEnhancer(metaEd); enhance(metaEd); } @@ -3531,3 +3539,83 @@ describe('when testing projectEndpointName transformation in ApiSchemaBuildingEn expect(projectSchema?.projectEndpointName).toBe('special-education'); }); }); + +describe('when building ApiSchema with OpenAPI base documents', () => { + const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); + metaEd.plugin.set('edfiApiSchema', newPluginEnvironment()); + const coreNamespaceName = 'EdFi'; + const extensionNamespaceName = 'SampleExtension'; + let coreNamespace: Namespace; + let extensionNamespace: Namespace; + + beforeAll(() => { + metaEd.dataStandardVersion = '5.2.0'; + + coreNamespace = { + ...newNamespace(), + namespaceName: coreNamespaceName, + projectName: 'Ed-Fi', + projectVersion: '5.2.0', + projectDescription: 'The Ed-Fi Data Standard v5.2', + }; + extensionNamespace = { + ...newNamespace(), + namespaceName: extensionNamespaceName, + isExtension: true, + dependencies: [coreNamespace], + projectName: 'Sample', + projectVersion: '1.1.0', + projectDescription: 'Sample Extension', + }; + + coreNamespace.data.educationOrganizationTypes = []; + coreNamespace.data.educationOrganizationHierarchy = {}; + extensionNamespace.data.educationOrganizationTypes = []; + extensionNamespace.data.educationOrganizationHierarchy = {}; + + metaEd.namespace.set(coreNamespaceName, coreNamespace); + metaEd.namespace.set(extensionNamespaceName, extensionNamespace); + + namespaceSetupEnhancer(metaEd); + openApiBaseDocumentEnhancer(metaEd); + + const extensionChangeQueriesDocument: Document = { + openapi: '3.0.0', + info: { + title: 'Extension Change Queries', + version: '1', + }, + paths: {}, + }; + + const extensionNamespaceEdfiApiSchema: NamespaceEdfiApiSchema = extensionNamespace.data + .edfiApiSchema as NamespaceEdfiApiSchema; + extensionNamespaceEdfiApiSchema.openApiBaseDocuments = { + [OpenApiDocumentType.CHANGE_QUERIES]: extensionChangeQueriesDocument, + }; + + enhance(metaEd); + }); + + it('should copy optional standalone Change Queries base document into core project schema', () => { + const namespaceEdfiApiSchema: NamespaceEdfiApiSchema = coreNamespace.data.edfiApiSchema as NamespaceEdfiApiSchema; + + expect(namespaceEdfiApiSchema.apiSchema.projectSchema.openApiBaseDocuments).toBeDefined(); + expect(namespaceEdfiApiSchema.apiSchema.projectSchema.openApiBaseDocuments?.[OpenApiDocumentType.CHANGE_QUERIES]).toBe( + namespaceEdfiApiSchema.openApiBaseDocuments?.[OpenApiDocumentType.CHANGE_QUERIES], + ); + }); + + it('should not copy base documents into extension project schema', () => { + const namespaceEdfiApiSchema: NamespaceEdfiApiSchema = extensionNamespace.data.edfiApiSchema as NamespaceEdfiApiSchema; + + expect(namespaceEdfiApiSchema.openApiBaseDocuments?.[OpenApiDocumentType.CHANGE_QUERIES]).toBeDefined(); + expect(namespaceEdfiApiSchema.apiSchema.projectSchema.openApiBaseDocuments).toBeUndefined(); + }); + + it('should keep apiSchemaVersion unchanged', () => { + const namespaceEdfiApiSchema: NamespaceEdfiApiSchema = coreNamespace.data.edfiApiSchema as NamespaceEdfiApiSchema; + + expect(namespaceEdfiApiSchema.apiSchema.apiSchemaVersion).toBe('1.0.0'); + }); +}); diff --git a/packages/metaed-plugin-edfi-api-schema/test/enhancer/IdentityJsonPathsEnhancer.test.ts b/packages/metaed-plugin-edfi-api-schema/test/enhancer/IdentityJsonPathsEnhancer.test.ts index fb4032479..fa28e50e7 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/enhancer/IdentityJsonPathsEnhancer.test.ts +++ b/packages/metaed-plugin-edfi-api-schema/test/enhancer/IdentityJsonPathsEnhancer.test.ts @@ -1260,3 +1260,33 @@ describe('when building domain entity referencing another which has inline commo `); }); }); + +describe('when building a school year enumeration', () => { + const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); + metaEd.plugin.set('edfiApiSchema', newPluginEnvironment()); + const namespaceName = 'EdFi'; + + beforeAll(() => { + MetaEdTextBuilder.build() + .withBeginNamespace(namespaceName) + .withStartEnumeration('SchoolYear') + .withDocumentation('doc') + .withEnumerationItem('2022') + .withEndEnumeration() + .withEndNamespace() + .sendToListener(new NamespaceBuilder(metaEd, [])) + .sendToListener(new EnumerationBuilder(metaEd, [])); + + runApiSchemaEnhancers(metaEd); + }); + + it('should be correct identityJsonPaths for SchoolYearType', () => { + const entity = metaEd.namespace.get(namespaceName)?.entity.schoolYearEnumeration.get('SchoolYear'); + const identityJsonPaths = entity?.data.edfiApiSchema.identityJsonPaths; + expect(identityJsonPaths).toMatchInlineSnapshot(` + Array [ + "$.schoolYear", + ] + `); + }); +}); diff --git a/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiBaseDocumentEnhancer.test.ts b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiBaseDocumentEnhancer.test.ts index 2fd14571b..ac093c1a9 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiBaseDocumentEnhancer.test.ts +++ b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiBaseDocumentEnhancer.test.ts @@ -14,6 +14,7 @@ import { import { enhance as namespaceSetupEnhancer } from '../../src/model/Namespace'; import { enhance } from '../../src/enhancer/OpenApiBaseDocumentEnhancer'; import { NamespaceEdfiApiSchema } from '../../src/model/Namespace'; +import { OpenApiDocumentType } from '../../src/model/api-schema/OpenApiDocumentType'; describe('OpenApiBaseDocumentEnhancer', () => { describe('when enhancing a core namespace', () => { @@ -47,7 +48,7 @@ describe('OpenApiBaseDocumentEnhancer', () => { it('should create base document for resources', () => { const namespaceEdfiApiSchema = namespace?.data.edfiApiSchema as NamespaceEdfiApiSchema; - const resourcesDoc = namespaceEdfiApiSchema.openApiBaseDocuments?.resources; + const resourcesDoc = namespaceEdfiApiSchema.openApiBaseDocuments?.[OpenApiDocumentType.RESOURCES]; expect(resourcesDoc).toBeDefined(); expect(resourcesDoc?.openapi).toBe('3.0.0'); @@ -59,12 +60,16 @@ describe('OpenApiBaseDocumentEnhancer', () => { expect(resourcesDoc?.components?.schemas?.EdFi_SchoolYearTypeReference).toBeDefined(); expect(resourcesDoc?.components?.responses).toBeDefined(); expect(resourcesDoc?.components?.parameters).toBeDefined(); + expect(resourcesDoc?.components?.responses?.NotFoundUseSnapshot).toBeUndefined(); + expect(JSON.stringify(resourcesDoc)).not.toContain('Use-Snapshot'); + expect(JSON.stringify(resourcesDoc)).not.toContain('NotFoundUseSnapshot'); + expect(JSON.stringify(resourcesDoc)).not.toContain('snapshot'); expect(resourcesDoc?.tags).toEqual([]); }); it('should create base document for descriptors', () => { const namespaceEdfiApiSchema = namespace?.data.edfiApiSchema as NamespaceEdfiApiSchema; - const descriptorsDoc = namespaceEdfiApiSchema.openApiBaseDocuments?.descriptors; + const descriptorsDoc = namespaceEdfiApiSchema.openApiBaseDocuments?.[OpenApiDocumentType.DESCRIPTORS]; expect(descriptorsDoc).toBeDefined(); expect(descriptorsDoc?.openapi).toBe('3.0.0'); @@ -75,25 +80,114 @@ describe('OpenApiBaseDocumentEnhancer', () => { expect(descriptorsDoc?.components?.schemas).toEqual({}); expect(descriptorsDoc?.components?.responses).toBeDefined(); expect(descriptorsDoc?.components?.parameters).toBeDefined(); + expect(descriptorsDoc?.components?.responses?.NotFoundUseSnapshot).toBeUndefined(); + expect(JSON.stringify(descriptorsDoc)).not.toContain('Use-Snapshot'); + expect(JSON.stringify(descriptorsDoc)).not.toContain('NotFoundUseSnapshot'); + expect(JSON.stringify(descriptorsDoc)).not.toContain('snapshot'); expect(descriptorsDoc?.tags).toEqual([]); }); + it('should create standalone Change Queries base document for availableChangeVersions', () => { + const namespaceEdfiApiSchema = namespace?.data.edfiApiSchema as NamespaceEdfiApiSchema; + const changeQueriesDoc = namespaceEdfiApiSchema.openApiBaseDocuments?.[OpenApiDocumentType.CHANGE_QUERIES]; + const resourcesDoc = namespaceEdfiApiSchema.openApiBaseDocuments?.[OpenApiDocumentType.RESOURCES]; + const descriptorsDoc = namespaceEdfiApiSchema.openApiBaseDocuments?.[OpenApiDocumentType.DESCRIPTORS]; + + expect(changeQueriesDoc).toBeDefined(); + expect(changeQueriesDoc?.openapi).toBe('3.0.0'); + expect(changeQueriesDoc?.info?.title).toBe('Ed-Fi Data Management Service API'); + expect(changeQueriesDoc?.info?.version).toBe('1'); + expect(changeQueriesDoc?.servers).toHaveLength(1); + expect(changeQueriesDoc?.paths).toMatchInlineSnapshot(` + Object { + "/availableChangeVersions": Object { + "get": Object { + "operationId": "getAvailableChangeVersions", + "responses": Object { + "200": Object { + "content": Object { + "application/json": Object { + "schema": Object { + "properties": Object { + "newestChangeVersion": Object { + "format": "int64", + "type": "integer", + }, + "oldestChangeVersion": Object { + "format": "int64", + "type": "integer", + }, + }, + "required": Array [ + "oldestChangeVersion", + "newestChangeVersion", + ], + "type": "object", + }, + }, + }, + "description": "The available change version range was successfully retrieved.", + }, + }, + "summary": "Retrieves the available change version range.", + }, + }, + } + `); + expect(changeQueriesDoc?.paths['/availableChangeVersions']?.get?.parameters).toBeUndefined(); + expect(changeQueriesDoc?.paths['/changeQueries/v1/availableChangeVersions']).toBeUndefined(); + expect(resourcesDoc?.paths['/availableChangeVersions']).toBeUndefined(); + expect(descriptorsDoc?.paths['/availableChangeVersions']).toBeUndefined(); + expect(changeQueriesDoc?.components?.schemas).toEqual({}); + expect(changeQueriesDoc?.components?.responses).toEqual({}); + expect(changeQueriesDoc?.components?.parameters).toEqual({}); + expect(changeQueriesDoc?.components?.securitySchemes).toBeUndefined(); + expect(changeQueriesDoc?.security).toBeUndefined(); + expect(JSON.stringify(changeQueriesDoc)).not.toContain('Use-Snapshot'); + expect(JSON.stringify(changeQueriesDoc)).not.toContain('NotFoundUseSnapshot'); + expect(JSON.stringify(changeQueriesDoc)).not.toContain('snapshot'); + expect(JSON.stringify(changeQueriesDoc)).not.toContain('oauth2'); + expect(JSON.stringify(changeQueriesDoc)).not.toContain('tokenUrl'); + expect(changeQueriesDoc?.tags).toEqual([]); + }); + it('should include hardcoded component parameters', () => { const namespaceEdfiApiSchema = namespace?.data.edfiApiSchema as NamespaceEdfiApiSchema; - const resourcesDoc = namespaceEdfiApiSchema.openApiBaseDocuments?.resources; + const resourcesDoc = namespaceEdfiApiSchema.openApiBaseDocuments?.[OpenApiDocumentType.RESOURCES]; expect(resourcesDoc?.components?.parameters?.['If-None-Match']).toBeDefined(); expect(resourcesDoc?.components?.parameters?.limit).toBeDefined(); expect(resourcesDoc?.components?.parameters?.offset).toBeDefined(); + expect(resourcesDoc?.components?.parameters?.MinChangeVersion).toEqual({ + name: 'minChangeVersion', + in: 'query', + description: 'Used in synchronization to set sequence minimum ChangeVersion', + schema: { + minimum: 0, + type: 'integer', + format: 'int64', + }, + }); + expect(resourcesDoc?.components?.parameters?.MaxChangeVersion).toEqual({ + name: 'maxChangeVersion', + in: 'query', + description: 'Used in synchronization to set sequence maximum ChangeVersion', + schema: { + minimum: 0, + type: 'integer', + format: 'int64', + }, + }); }); it('should include hardcoded responses', () => { const namespaceEdfiApiSchema = namespace?.data.edfiApiSchema as NamespaceEdfiApiSchema; - const resourcesDoc = namespaceEdfiApiSchema.openApiBaseDocuments?.resources; + const resourcesDoc = namespaceEdfiApiSchema.openApiBaseDocuments?.[OpenApiDocumentType.RESOURCES]; expect(resourcesDoc?.components?.responses?.Created).toBeDefined(); expect(resourcesDoc?.components?.responses?.Updated).toBeDefined(); expect(resourcesDoc?.components?.responses?.NotFound).toBeDefined(); + expect(resourcesDoc?.components?.responses?.NotFoundUseSnapshot).toBeUndefined(); expect(resourcesDoc?.components?.responses?.BadRequest).toBeDefined(); }); }); diff --git a/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts new file mode 100644 index 000000000..1cf546589 --- /dev/null +++ b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiChangeQuerySchemaBuilder.test.ts @@ -0,0 +1,483 @@ +// 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 EntityProperty, + type IntegerProperty, + newEntityProperty, + type StringProperty, + type TopLevelEntity, +} from '@edfi/metaed-core'; +import { createTrackedChangeSchemasFrom } from '../../src/enhancer/OpenApiChangeQuerySchemaBuilder'; +import type { TrackedChangeKeyField, TrackedChangeKeyFieldName } from '../../src/model/TrackedChangeKeyField'; + +/** + * A tracked-change identity source property case used to verify scalar OpenAPI schema mapping. + */ +type ScalarIdentitySourcePropertyCase = { + fieldName: TrackedChangeKeyFieldName; + sourceProperty: EntityProperty; +}; + +/** + * Creates a source property with only semantic type and documentation needed by tracked-change schema tests. + */ +function sourcePropertyOfType(propertyType: EntityProperty['type'], documentation: string): EntityProperty { + return { + ...newEntityProperty(), + type: propertyType, + documentation, + }; +} + +/** + * Creates a string source property for tracked-change schema tests. + */ +function stringSourceProperty(): EntityProperty { + return { + ...newEntityProperty(), + type: 'string', + documentation: 'Student Unique Id', + minLength: '1', + maxLength: '32', + } as StringProperty; +} + +/** + * Creates an integer source property for tracked-change schema tests. + */ +function integerSourceProperty(): EntityProperty { + return { + ...newEntityProperty(), + type: 'integer', + documentation: 'School Id', + hasBigHint: false, + } as IntegerProperty; +} + +/** + * Creates a big integer source property for tracked-change schema tests. + */ +function bigIntegerSourceProperty(): EntityProperty { + return { + ...newEntityProperty(), + type: 'integer', + documentation: 'Big integer identity field', + hasBigHint: true, + } as IntegerProperty; +} + +/** + * Creates a descriptor source property for tracked-change schema tests. + */ +function descriptorSourceProperty(): EntityProperty { + return { + ...newEntityProperty(), + type: 'descriptor', + documentation: 'Entry grade level descriptor', + }; +} + +/** + * Creates source property cases for tracked-change scalar schema mapping tests. + */ +function scalarIdentitySourcePropertyCases(): ScalarIdentitySourcePropertyCase[] { + return [ + { + fieldName: 'booleanIdentity' as TrackedChangeKeyFieldName, + sourceProperty: sourcePropertyOfType('boolean', 'Boolean identity field'), + }, + { + fieldName: 'dateIdentity' as TrackedChangeKeyFieldName, + sourceProperty: sourcePropertyOfType('date', 'Date identity field'), + }, + { + fieldName: 'dateTimeIdentity' as TrackedChangeKeyFieldName, + sourceProperty: sourcePropertyOfType('datetime', 'Date-time identity field'), + }, + { + fieldName: 'decimalIdentity' as TrackedChangeKeyFieldName, + sourceProperty: sourcePropertyOfType('decimal', 'Decimal identity field'), + }, + { + fieldName: 'descriptorIdentity' as TrackedChangeKeyFieldName, + sourceProperty: descriptorSourceProperty(), + }, + { + fieldName: 'durationIdentity' as TrackedChangeKeyFieldName, + sourceProperty: sourcePropertyOfType('duration', 'Duration identity field'), + }, + { + fieldName: 'int64Identity' as TrackedChangeKeyFieldName, + sourceProperty: bigIntegerSourceProperty(), + }, + { + fieldName: 'schoolYearIdentity' as TrackedChangeKeyFieldName, + sourceProperty: sourcePropertyOfType('schoolYearEnumeration', 'School year identity field'), + }, + { + fieldName: 'stringIdentity' as TrackedChangeKeyFieldName, + sourceProperty: stringSourceProperty(), + }, + { + fieldName: 'timeIdentity' as TrackedChangeKeyFieldName, + sourceProperty: sourcePropertyOfType('time', 'Time identity field'), + }, + { + fieldName: 'yearIdentity' as TrackedChangeKeyFieldName, + sourceProperty: sourcePropertyOfType('year', 'Year identity field'), + }, + ]; +} + +/** + * Creates tracked-change key field metadata from scalar source property cases. + */ +function trackedChangeKeyFieldsFrom(sourcePropertyCases: ScalarIdentitySourcePropertyCase[]): TrackedChangeKeyField[] { + return sourcePropertyCases.map((sourcePropertyCase: ScalarIdentitySourcePropertyCase) => ({ + fieldName: sourcePropertyCase.fieldName, + sourceProperty: sourcePropertyCase.sourceProperty, + })); +} + +/** + * Creates regular resource tracked-change key field metadata for tracked-change schema tests. + */ +function regularResourceTrackedChangeKeyFields(): TrackedChangeKeyField[] { + return [ + { + fieldName: 'entryGradeLevelDescriptor' as TrackedChangeKeyFieldName, + sourceProperty: descriptorSourceProperty(), + }, + { + fieldName: 'schoolId' as TrackedChangeKeyFieldName, + sourceProperty: integerSourceProperty(), + }, + { + fieldName: 'studentUniqueId' as TrackedChangeKeyFieldName, + sourceProperty: stringSourceProperty(), + }, + ]; +} + +/** + * Creates a top-level entity with explicit tracked-change key fields for tracked-change schema generation. + */ +function topLevelEntityWithTrackedChangeKeyFields( + type: string, + metaEdName: string, + isAbstract: boolean, + trackedChangeKeyFields: TrackedChangeKeyField[], +): TopLevelEntity { + return { + type, + metaEdName, + isAbstract, + namespace: { + namespaceName: 'EdFi', + }, + data: { + edfiApiSchema: { + trackedChangeKeyFields, + }, + }, + } as unknown as TopLevelEntity; +} + +/** + * Creates a top-level entity with only the data needed by tracked-change schema generation. + */ +function topLevelEntityWith( + type: string, + metaEdName: string, + isAbstract: boolean, + trackedChangeKeyFields: TrackedChangeKeyField[], +): TopLevelEntity { + return topLevelEntityWithTrackedChangeKeyFields(type, metaEdName, isAbstract, trackedChangeKeyFields); +} + +describe('OpenApiChangeQuerySchemaBuilder', () => { + describe('when creating schemas for a regular resource', () => { + const entity: TopLevelEntity = topLevelEntityWith( + 'association', + 'StudentSchoolAssociation', + false, + regularResourceTrackedChangeKeyFields(), + ); + + it('should create tracked-change schemas from public identity query fields', () => { + expect(createTrackedChangeSchemasFrom(entity)).toMatchInlineSnapshot(` + Object { + "EdFi_StudentSchoolAssociation_TrackedChangeDelete": Object { + "properties": Object { + "changeVersion": Object { + "format": "int64", + "type": "integer", + }, + "id": Object { + "type": "string", + }, + "keyValues": Object { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey", + }, + }, + "required": Array [ + "id", + "changeVersion", + "keyValues", + ], + "type": "object", + }, + "EdFi_StudentSchoolAssociation_TrackedChangeKey": Object { + "properties": Object { + "entryGradeLevelDescriptor": Object { + "maxLength": 306, + "type": "string", + }, + "schoolId": Object { + "format": "int32", + "type": "integer", + }, + "studentUniqueId": Object { + "maxLength": 32, + "minLength": 1, + "type": "string", + }, + }, + "required": Array [ + "entryGradeLevelDescriptor", + "schoolId", + "studentUniqueId", + ], + "type": "object", + }, + "EdFi_StudentSchoolAssociation_TrackedChangeKeyChange": Object { + "properties": Object { + "changeVersion": Object { + "format": "int64", + "type": "integer", + }, + "id": Object { + "type": "string", + }, + "newKeyValues": Object { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey", + }, + "oldKeyValues": Object { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey", + }, + }, + "required": Array [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues", + ], + "type": "object", + }, + } + `); + }); + }); + + describe('when creating key schemas from scalar identity source properties', () => { + const sourcePropertyCases: ScalarIdentitySourcePropertyCase[] = scalarIdentitySourcePropertyCases(); + const entity: TopLevelEntity = topLevelEntityWithTrackedChangeKeyFields( + 'domainEntity', + 'ScalarIdentityResource', + false, + trackedChangeKeyFieldsFrom(sourcePropertyCases), + ); + + it('should use the standard OpenAPI schema mapping for tracked-change identity fields', () => { + expect(createTrackedChangeSchemasFrom(entity).EdFi_ScalarIdentityResource_TrackedChangeKey).toMatchInlineSnapshot(` + Object { + "properties": Object { + "booleanIdentity": Object { + "type": "boolean", + }, + "dateIdentity": Object { + "format": "date", + "type": "string", + }, + "dateTimeIdentity": Object { + "format": "date-time", + "type": "string", + }, + "decimalIdentity": Object { + "format": "double", + "type": "number", + }, + "descriptorIdentity": Object { + "maxLength": 306, + "type": "string", + }, + "durationIdentity": Object { + "maxLength": 30, + "type": "string", + }, + "int64Identity": Object { + "format": "int64", + "type": "integer", + }, + "schoolYearIdentity": Object { + "format": "int32", + "type": "integer", + }, + "stringIdentity": Object { + "maxLength": 32, + "minLength": 1, + "type": "string", + }, + "timeIdentity": Object { + "type": "string", + }, + "yearIdentity": Object { + "format": "int32", + "type": "integer", + }, + }, + "required": Array [ + "booleanIdentity", + "dateIdentity", + "dateTimeIdentity", + "decimalIdentity", + "descriptorIdentity", + "durationIdentity", + "int64Identity", + "schoolYearIdentity", + "stringIdentity", + "timeIdentity", + "yearIdentity", + ], + "type": "object", + } + `); + }); + }); + + describe('when creating schemas for a concrete resource without complete public identity field metadata', () => { + const entity: TopLevelEntity = topLevelEntityWith('domainEntity', 'Student', false, []); + + it('should fail rather than create partial tracked-change schemas', () => { + expect(() => createTrackedChangeSchemasFrom(entity)).toThrow( + 'Unable to create tracked-change key schema for EdFi.Student. No tracked-change key fields were found.', + ); + }); + }); + + describe('when creating schemas for a descriptor', () => { + const entity: TopLevelEntity = { + type: 'descriptor', + metaEdName: 'GradeLevel', + namespace: { + namespaceName: 'EdFi', + }, + data: { + edfiApiSchema: {}, + }, + } as unknown as TopLevelEntity; + + it('should create tracked-change schemas with descriptor public identity fields', () => { + expect(createTrackedChangeSchemasFrom(entity)).toMatchInlineSnapshot(` + Object { + "EdFi_GradeLevelDescriptor_TrackedChangeDelete": Object { + "properties": Object { + "changeVersion": Object { + "format": "int64", + "type": "integer", + }, + "id": Object { + "type": "string", + }, + "keyValues": Object { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey", + }, + }, + "required": Array [ + "id", + "changeVersion", + "keyValues", + ], + "type": "object", + }, + "EdFi_GradeLevelDescriptor_TrackedChangeKey": Object { + "properties": Object { + "codeValue": Object { + "maxLength": 50, + "type": "string", + }, + "namespace": Object { + "maxLength": 255, + "type": "string", + }, + }, + "required": Array [ + "namespace", + "codeValue", + ], + "type": "object", + }, + "EdFi_GradeLevelDescriptor_TrackedChangeKeyChange": Object { + "properties": Object { + "changeVersion": Object { + "format": "int64", + "type": "integer", + }, + "id": Object { + "type": "string", + }, + "newKeyValues": Object { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey", + }, + "oldKeyValues": Object { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey", + }, + }, + "required": Array [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues", + ], + "type": "object", + }, + } + `); + }); + }); + + describe('when creating schemas for a concrete subclass resource', () => { + const entity: TopLevelEntity = topLevelEntityWith( + 'domainEntitySubclass', + 'School', + false, + regularResourceTrackedChangeKeyFields(), + ); + + it('should create tracked-change schemas for the concrete resource', () => { + expect(Object.keys(createTrackedChangeSchemasFrom(entity))).toMatchInlineSnapshot(` + Array [ + "EdFi_School_TrackedChangeKey", + "EdFi_School_TrackedChangeDelete", + "EdFi_School_TrackedChangeKeyChange", + ] + `); + }); + }); + + describe('when creating schemas for an abstract resource', () => { + const entity: TopLevelEntity = topLevelEntityWith( + 'domainEntity', + 'EducationOrganization', + true, + regularResourceTrackedChangeKeyFields(), + ); + + it('should not create tracked-change schemas', () => { + expect(createTrackedChangeSchemasFrom(entity)).toMatchInlineSnapshot(`Object {}`); + }); + }); +}); diff --git a/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts index 3d305e764..7b464edb9 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts +++ b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiResourceFragmentEnhancer.test.ts @@ -6,42 +6,153 @@ import { DomainEntityBuilder, DomainEntityExtensionBuilder, + DomainEntitySubclassBuilder, DescriptorBuilder, - MetaEdEnvironment, + EnumerationBuilder, MetaEdTextBuilder, NamespaceBuilder, + type Enhancer, newMetaEdEnvironment, newPluginEnvironment, } from '@edfi/metaed-core'; +import type { MetaEdEnvironment, Namespace, SchoolYearEnumeration, TopLevelEntity } from '@edfi/metaed-core'; import { domainEntityReferenceEnhancer, descriptorReferenceEnhancer, domainEntityExtensionBaseClassEnhancer, + domainEntitySubclassBaseClassEnhancer, } from '@edfi/metaed-plugin-edfi-unified'; import { enhance as entityPropertyApiSchemaDataSetupEnhancer } from '../../src/model/EntityPropertyApiSchemaData'; import { enhance as entityApiSchemaDataSetupEnhancer } from '../../src/model/EntityApiSchemaData'; import { enhance as namespaceSetupEnhancer } from '../../src/model/Namespace'; import { enhance as apiPropertyMappingEnhancer } from '../../src/enhancer/ApiPropertyMappingEnhancer'; import { enhance as apiEntityMappingEnhancer } from '../../src/enhancer/ApiEntityMappingEnhancer'; +import { enhance as subclassApiEntityMappingEnhancer } from '../../src/enhancer/SubclassApiEntityMappingEnhancer'; +import { enhance as mergeCoveringFlattenedIdentityPropertyEnhancer } from '../../src/enhancer/MergeCoveringFlattenedIdentityPropertyEnhancer'; import { enhance as propertyCollectingEnhancer } from '../../src/enhancer/PropertyCollectingEnhancer'; import { enhance as resourceNameEnhancer } from '../../src/enhancer/ResourceNameEnhancer'; import { enhance as apiSchemaBuildingEnhancer } from '../../src/enhancer/ApiSchemaBuildingEnhancer'; import { enhance as openApiRequestBodyComponentEnhancer } from '../../src/enhancer/OpenApiRequestBodyComponentEnhancer'; import { enhance as openApiReferenceComponentEnhancer } from '../../src/enhancer/OpenApiReferenceComponentEnhancer'; +import { enhance as openApiTrackedChangeKeyFieldEnhancer } from '../../src/enhancer/OpenApiTrackedChangeKeyFieldEnhancer'; import { enhance as resourceDomainEnhancer } from '../../src/enhancer/ResourceDomainEnhancer'; import { enhance as jsonSchemaForInsertEnhancer } from '../../src/enhancer/JsonSchemaForInsertEnhancer'; import { enhance as referenceComponentEnhancer } from '../../src/enhancer/ReferenceComponentEnhancer'; import { enhance as allJsonPathsMappingEnhancer } from '../../src/enhancer/AllJsonPathsMappingEnhancer'; +import { enhance as mergeJsonPathsMappingEnhancer } from '../../src/enhancer/MergeJsonPathsMappingEnhancer'; import { enhance as mergeDirectiveEqualityConstraintEnhancer } from '../../src/enhancer/MergeDirectiveEqualityConstraintEnhancer'; import { enhance as identityFullnameEnhancer } from '../../src/enhancer/IdentityFullnameEnhancer'; +import { enhance as subclassIdentityFullnameEnhancer } from '../../src/enhancer/SubclassIdentityFullnameEnhancer'; import { enhance as identityJsonPathsEnhancer } from '../../src/enhancer/IdentityJsonPathsEnhancer'; import { enhance as documentPathsMappingEnhancer } from '../../src/enhancer/DocumentPathsMappingEnhancer'; +import { enhance as queryFieldMappingEnhancer } from '../../src/enhancer/QueryFieldMappingEnhancer'; import { enhance as typeCoercionJsonPathsEnhancer } from '../../src/enhancer/TypeCoercionJsonPathsEnhancer'; -import { enhance } from '../../src/enhancer/OpenApiResourceFragmentEnhancer'; +import { createResourceFragment, enhance } from '../../src/enhancer/OpenApiResourceFragmentEnhancer'; import { NamespaceEdfiApiSchema } from '../../src/model/Namespace'; import { OpenApiDocumentType } from '../../src/model/api-schema/OpenApiDocumentType'; +import type { JsonPath } from '../../src/model/api-schema/JsonPath'; +import type { OpenApiFragment } from '../../src/model/api-schema/OpenApiFragment'; +import type { Operation, Parameter } from '../../src/model/OpenApiTypes'; +import { metaEdPluginEnhancers } from '../integration/PluginHelper'; + +/** + * OpenAPI operation methods generated by the resource fragment enhancer. + */ +type OpenApiOperationMethod = 'get' | 'post' | 'put' | 'delete'; + +const changeVersionParameterRefs: string[] = [ + '#/components/parameters/MinChangeVersion', + '#/components/parameters/MaxChangeVersion', +]; + +const trackedChangeParameterRefs: string[] = [ + '#/components/parameters/MinChangeVersion', + '#/components/parameters/MaxChangeVersion', + '#/components/parameters/limit', + '#/components/parameters/offset', + '#/components/parameters/totalCount', +]; + +const cursorPagingParameterRefs: string[] = ['#/components/parameters/pageToken', '#/components/parameters/pageSize']; + +/** + * Returns an operation from a fragment path for focused OpenAPI assertions. + */ +function operationFrom(fragment: OpenApiFragment, path: string, method: OpenApiOperationMethod): Operation { + const operation = fragment.paths?.[path]?.[method]; + expect(operation).toBeDefined(); + return operation as Operation; +} + +/** + * Returns component parameter references from an OpenAPI operation. + */ +function parameterRefsFrom(operation: Operation): string[] { + return (operation.parameters ?? []).flatMap((parameter: Parameter) => ('$ref' in parameter ? [parameter.$ref] : [])); +} + +/** + * Returns inline parameter names from an OpenAPI operation. + */ +function parameterNamesFrom(operation: Operation): string[] { + return (operation.parameters ?? []).flatMap((parameter: Parameter) => ('name' in parameter ? [parameter.name] : [])); +} + +/** + * Asserts an operation advertises live Change Query filter parameters. + */ +function expectLiveChangeVersionFilterParameters(operation: Operation): void { + expect(parameterRefsFrom(operation)).toEqual(expect.arrayContaining(changeVersionParameterRefs)); +} + +/** + * Asserts an operation does not advertise live Change Query filter parameters. + */ +function expectNoLiveChangeVersionFilterParameters(operation: Operation): void { + const parameterRefs: string[] = parameterRefsFrom(operation); + changeVersionParameterRefs.forEach((parameterRef: string) => expect(parameterRefs).not.toContain(parameterRef)); +} + +/** + * Asserts an operation advertises only the tracked-change query parameters. + */ +function expectTrackedChangeQueryParameters(operation: Operation): void { + const parameterRefs: string[] = parameterRefsFrom(operation); + + expect(parameterRefs).toEqual(trackedChangeParameterRefs); + cursorPagingParameterRefs.forEach((parameterRef: string) => expect(parameterRefs).not.toContain(parameterRef)); + expect(parameterNamesFrom(operation)).toEqual([]); +} + +/** + * Asserts a tracked-change operation references the expected response item schema. + */ +function expectTrackedChangeResponseSchema(operation: Operation, trackedChangeItemSchemaName: string): void { + expect(operation.responses['200']).toEqual({ + description: 'The requested Change Query results were successfully retrieved.', + content: { + 'application/json': { + schema: { + type: 'array', + items: { + $ref: `#/components/schemas/${trackedChangeItemSchemaName}`, + }, + }, + }, + }, + }); +} + +/** + * Asserts an operation advertises a tracked-change response and query parameter contract. + */ +function expectTrackedChangeOperation(operation: Operation, trackedChangeItemSchemaName: string): void { + expectTrackedChangeQueryParameters(operation); + expectTrackedChangeResponseSchema(operation, trackedChangeItemSchemaName); +} function runPrerequisiteEnhancers(metaEd: MetaEdEnvironment) { + metaEdPluginEnhancers().forEach((pluginEnhancer: Enhancer) => pluginEnhancer(metaEd)); namespaceSetupEnhancer(metaEd); entityPropertyApiSchemaDataSetupEnhancer(metaEd); entityApiSchemaDataSetupEnhancer(metaEd); @@ -49,12 +160,18 @@ function runPrerequisiteEnhancers(metaEd: MetaEdEnvironment) { apiPropertyMappingEnhancer(metaEd); propertyCollectingEnhancer(metaEd); apiEntityMappingEnhancer(metaEd); + subclassApiEntityMappingEnhancer(metaEd); + mergeCoveringFlattenedIdentityPropertyEnhancer(metaEd); + openApiTrackedChangeKeyFieldEnhancer(metaEd); jsonSchemaForInsertEnhancer(metaEd); allJsonPathsMappingEnhancer(metaEd); + mergeJsonPathsMappingEnhancer(metaEd); mergeDirectiveEqualityConstraintEnhancer(metaEd); resourceNameEnhancer(metaEd); documentPathsMappingEnhancer(metaEd); identityFullnameEnhancer(metaEd); + subclassIdentityFullnameEnhancer(metaEd); + queryFieldMappingEnhancer(metaEd); identityJsonPathsEnhancer(metaEd); typeCoercionJsonPathsEnhancer(metaEd); resourceDomainEnhancer(metaEd); @@ -62,6 +179,44 @@ function runPrerequisiteEnhancers(metaEd: MetaEdEnvironment) { openApiReferenceComponentEnhancer(metaEd); } +/** + * Creates a concrete resource whose identity metadata cannot derive public tracked-change key schemas. + */ +function concreteResourceWithoutPublicTrackedChangeKeyMetadata(): TopLevelEntity { + return { + type: 'domainEntity', + metaEdName: 'Student', + documentation: 'A student', + allowPrimaryKeyUpdates: false, + namespace: { + namespaceName: 'EdFi', + projectName: 'Ed-Fi', + isExtension: false, + }, + data: { + edfiApiSchema: { + endpointName: 'students', + domains: [], + identityJsonPaths: ['$.studentUniqueId' as JsonPath], + trackedChangeKeyFields: [], + queryFieldMapping: {}, + openApiReferenceComponent: {}, + openApiReferenceComponentPropertyName: '', + openApiRequestBodyComponent: { + type: 'object', + properties: { + id: { + type: 'string', + }, + }, + }, + openApiRequestBodyComponentPropertyName: 'EdFi_Student', + openApiRequestBodyCollectionComponents: [], + }, + }, + } as unknown as TopLevelEntity; +} + describe('OpenApiResourceFragmentEnhancer', () => { describe('when enhancing a domain entity', () => { const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); @@ -108,9 +263,138 @@ describe('OpenApiResourceFragmentEnhancer', () => { expect(fragment?.components?.schemas?.EdFi_Student).toBeDefined(); expect(fragment?.paths).toBeDefined(); expect(fragment?.paths?.['/ed-fi/students']).toBeDefined(); + expect(fragment?.paths?.['/ed-fi/students/deletes']).toBeDefined(); + expect(fragment?.paths?.['/ed-fi/students/keyChanges']).toBeDefined(); expect(fragment?.tags).toBeDefined(); expect(fragment?.tags).toHaveLength(1); expect(fragment?.tags?.[0].name).toBe('students'); + + const serializedFragment: string = JSON.stringify(fragment); + expect(serializedFragment).not.toContain('Use-Snapshot'); + expect(serializedFragment).not.toContain('NotFoundUseSnapshot'); + expect(serializedFragment).not.toContain('snapshot'); + expect(fragment?.paths?.['/ed-fi/students']?.get?.responses['404']).toEqual({ + $ref: '#/components/responses/NotFound', + }); + expect(fragment?.paths?.['/ed-fi/students/{id}']?.get?.responses['404']).toEqual({ + $ref: '#/components/responses/NotFound', + }); + expect(fragment?.paths?.['/ed-fi/students']?.post?.responses['405']).toEqual({ + description: 'Method Is Not Allowed.', + }); + expect(fragment?.paths?.['/ed-fi/students/{id}']?.put?.responses['405']).toEqual({ + description: 'Method Is Not Allowed.', + }); + expect(fragment?.paths?.['/ed-fi/students/{id}']?.delete?.responses['405']).toEqual({ + description: 'Method Is Not Allowed.', + }); + }); + + it('should add live Change Query filters only to the GET-many operation', () => { + const student = namespace.entity.domainEntity.get('Student'); + const studentApiData = student.data.edfiApiSchema; + const fragment = studentApiData.openApiFragments[OpenApiDocumentType.RESOURCES] as OpenApiFragment; + + expectLiveChangeVersionFilterParameters(operationFrom(fragment, '/ed-fi/students', 'get')); + expectNoLiveChangeVersionFilterParameters(operationFrom(fragment, '/ed-fi/students', 'post')); + expectNoLiveChangeVersionFilterParameters(operationFrom(fragment, '/ed-fi/students/{id}', 'get')); + expectNoLiveChangeVersionFilterParameters(operationFrom(fragment, '/ed-fi/students/{id}', 'put')); + expectNoLiveChangeVersionFilterParameters(operationFrom(fragment, '/ed-fi/students/{id}', 'delete')); + }); + + it('should add tracked-change delete and key-change paths with response schemas', () => { + const student = namespace.entity.domainEntity.get('Student'); + const studentApiData = student.data.edfiApiSchema; + const fragment = studentApiData.openApiFragments[OpenApiDocumentType.RESOURCES] as OpenApiFragment; + + expectTrackedChangeOperation( + operationFrom(fragment, '/ed-fi/students/deletes', 'get'), + 'EdFi_Student_TrackedChangeDelete', + ); + expectTrackedChangeOperation( + operationFrom(fragment, '/ed-fi/students/keyChanges', 'get'), + 'EdFi_Student_TrackedChangeKeyChange', + ); + expect(fragment.paths?.['/ed-fi/students/deletes']?.['x-Ed-Fi-domains']).toEqual([]); + expect(fragment.paths?.['/ed-fi/students/keyChanges']?.['x-Ed-Fi-domains']).toEqual([]); + }); + + it('should emit profile-compatible unprofiled tracked-change fragments', () => { + const student = namespace.entity.domainEntity.get('Student'); + const studentApiData = student.data.edfiApiSchema; + const fragment = studentApiData.openApiFragments[OpenApiDocumentType.RESOURCES] as OpenApiFragment; + const collectionPath: string = '/ed-fi/students'; + const trackedChangeSchemaNames: string[] = Object.keys(fragment.components.schemas) + .filter((schemaName: string) => schemaName.includes('_TrackedChange')) + .sort(); + + expect(fragment.paths?.[`${collectionPath}/deletes`]).toBeDefined(); + expect(fragment.paths?.[`${collectionPath}/keyChanges`]).toBeDefined(); + expect(fragment.paths?.[`${collectionPath}/{id}/deletes`]).toBeUndefined(); + expect(fragment.paths?.[`${collectionPath}/{id}/keyChanges`]).toBeUndefined(); + expect(fragment.paths?.['/availableChangeVersions']).toBeUndefined(); + expect(fragment.paths?.['/changeQueries/v1/availableChangeVersions']).toBeUndefined(); + expect(operationFrom(fragment, `${collectionPath}/deletes`, 'get').responses['200']).toMatchInlineSnapshot(` + Object { + "content": Object { + "application/json": Object { + "schema": Object { + "items": Object { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeDelete", + }, + "type": "array", + }, + }, + }, + "description": "The requested Change Query results were successfully retrieved.", + } + `); + expect(operationFrom(fragment, `${collectionPath}/keyChanges`, 'get').responses['200']).toMatchInlineSnapshot(` + Object { + "content": Object { + "application/json": Object { + "schema": Object { + "items": Object { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKeyChange", + }, + "type": "array", + }, + }, + }, + "description": "The requested Change Query results were successfully retrieved.", + } + `); + expect(trackedChangeSchemaNames).toEqual([ + 'EdFi_Student_TrackedChangeDelete', + 'EdFi_Student_TrackedChangeKey', + 'EdFi_Student_TrackedChangeKeyChange', + ]); + expect(fragment.components.schemas.EdFi_Student_TrackedChangeKey).toMatchInlineSnapshot(` + Object { + "properties": Object { + "studentUniqueId": Object { + "maxLength": 30, + "minLength": 20, + "type": "string", + }, + }, + "required": Array [ + "studentUniqueId", + ], + "type": "object", + } + `); + trackedChangeSchemaNames.forEach((schemaName: string) => { + const serializedSchema: string = JSON.stringify(fragment.components.schemas[schemaName]); + + expect(schemaName).not.toContain('_readable'); + expect(schemaName).not.toContain('_writable'); + expect(serializedSchema).not.toContain('_readable'); + expect(serializedSchema).not.toContain('_writable'); + expect(serializedSchema).not.toContain('active'); + expect(serializedSchema).not.toContain('_etag'); + expect(serializedSchema).not.toContain('_lastModifiedDate'); + }); }); it('should not create a descriptors fragment for domain entities', () => { @@ -122,6 +406,14 @@ describe('OpenApiResourceFragmentEnhancer', () => { }); }); + describe('when creating a resource fragment without public tracked-change key metadata', () => { + it('should fail rather than omit tracked-change paths', () => { + expect(() => createResourceFragment(concreteResourceWithoutPublicTrackedChangeKeyMetadata())).toThrow( + 'Unable to create tracked-change key schema for EdFi.Student. No tracked-change key fields were found.', + ); + }); + }); + describe('when enhancing a descriptor', () => { const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); metaEd.plugin.set('edfiApiSchema', newPluginEnvironment()); @@ -156,9 +448,58 @@ describe('OpenApiResourceFragmentEnhancer', () => { expect(fragment?.components?.schemas?.EdFi_GradeLevelDescriptor).toBeDefined(); expect(fragment?.paths).toBeDefined(); expect(fragment?.paths?.['/ed-fi/gradeLevelDescriptors']).toBeDefined(); + expect(fragment?.paths?.['/ed-fi/gradeLevelDescriptors/deletes']).toBeDefined(); + expect(fragment?.paths?.['/ed-fi/gradeLevelDescriptors/keyChanges']).toBeDefined(); expect(fragment?.tags).toBeDefined(); expect(fragment?.tags).toHaveLength(1); expect(fragment?.tags?.[0].name).toBe('gradeLevelDescriptors'); + + const serializedFragment: string = JSON.stringify(fragment); + expect(serializedFragment).not.toContain('Use-Snapshot'); + expect(serializedFragment).not.toContain('NotFoundUseSnapshot'); + expect(serializedFragment).not.toContain('snapshot'); + expect(fragment?.paths?.['/ed-fi/gradeLevelDescriptors']?.get?.responses['404']).toEqual({ + $ref: '#/components/responses/NotFound', + }); + expect(fragment?.paths?.['/ed-fi/gradeLevelDescriptors/{id}']?.get?.responses['404']).toEqual({ + $ref: '#/components/responses/NotFound', + }); + expect(fragment?.paths?.['/ed-fi/gradeLevelDescriptors']?.post?.responses['405']).toEqual({ + description: 'Method Is Not Allowed.', + }); + expect(fragment?.paths?.['/ed-fi/gradeLevelDescriptors/{id}']?.put?.responses['405']).toEqual({ + description: 'Method Is Not Allowed.', + }); + expect(fragment?.paths?.['/ed-fi/gradeLevelDescriptors/{id}']?.delete?.responses['405']).toEqual({ + description: 'Method Is Not Allowed.', + }); + }); + + it('should add live Change Query filters only to the descriptor GET-many operation', () => { + const descriptor = namespace.entity.descriptor.get('GradeLevel'); + const descriptorApiData = descriptor.data.edfiApiSchema; + const fragment = descriptorApiData.openApiFragments[OpenApiDocumentType.DESCRIPTORS] as OpenApiFragment; + + expectLiveChangeVersionFilterParameters(operationFrom(fragment, '/ed-fi/gradeLevelDescriptors', 'get')); + expectNoLiveChangeVersionFilterParameters(operationFrom(fragment, '/ed-fi/gradeLevelDescriptors', 'post')); + expectNoLiveChangeVersionFilterParameters(operationFrom(fragment, '/ed-fi/gradeLevelDescriptors/{id}', 'get')); + expectNoLiveChangeVersionFilterParameters(operationFrom(fragment, '/ed-fi/gradeLevelDescriptors/{id}', 'put')); + expectNoLiveChangeVersionFilterParameters(operationFrom(fragment, '/ed-fi/gradeLevelDescriptors/{id}', 'delete')); + }); + + it('should add tracked-change delete and key-change paths with descriptor response schemas', () => { + const descriptor = namespace.entity.descriptor.get('GradeLevel'); + const descriptorApiData = descriptor.data.edfiApiSchema; + const fragment = descriptorApiData.openApiFragments[OpenApiDocumentType.DESCRIPTORS] as OpenApiFragment; + + expectTrackedChangeOperation( + operationFrom(fragment, '/ed-fi/gradeLevelDescriptors/deletes', 'get'), + 'EdFi_GradeLevelDescriptor_TrackedChangeDelete', + ); + expectTrackedChangeOperation( + operationFrom(fragment, '/ed-fi/gradeLevelDescriptors/keyChanges', 'get'), + 'EdFi_GradeLevelDescriptor_TrackedChangeKeyChange', + ); }); it('should not create a resources fragment for descriptors', () => { @@ -170,6 +511,53 @@ describe('OpenApiResourceFragmentEnhancer', () => { }); }); + describe('when enhancing a school year enumeration', () => { + const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); + metaEd.plugin.set('edfiApiSchema', newPluginEnvironment()); + const namespaceName = 'EdFi'; + let namespace: Namespace; + + beforeAll(() => { + MetaEdTextBuilder.build() + .withBeginNamespace(namespaceName) + .withStartEnumeration('SchoolYear') + .withDocumentation('School year') + .withEnumerationItem('2022') + .withEndEnumeration() + .withEndNamespace() + .sendToListener(new NamespaceBuilder(metaEd, [])) + .sendToListener(new EnumerationBuilder(metaEd, [])); + + runPrerequisiteEnhancers(metaEd); + enhance(metaEd); + + namespace = metaEd.namespace.get(namespaceName) as Namespace; + }); + + it('should add live Change Query filters to the SchoolYearType GET-many operation', () => { + const schoolYear = namespace.entity.schoolYearEnumeration.get('SchoolYear') as SchoolYearEnumeration; + const schoolYearApiData = schoolYear.data.edfiApiSchema; + const fragment = schoolYearApiData.openApiFragments[OpenApiDocumentType.RESOURCES] as OpenApiFragment; + + expectLiveChangeVersionFilterParameters(operationFrom(fragment, '/ed-fi/schoolYearTypes', 'get')); + }); + + it('should add tracked-change delete and key-change paths to SchoolYearType', () => { + const schoolYear = namespace.entity.schoolYearEnumeration.get('SchoolYear') as SchoolYearEnumeration; + const schoolYearApiData = schoolYear.data.edfiApiSchema; + const fragment = schoolYearApiData.openApiFragments[OpenApiDocumentType.RESOURCES] as OpenApiFragment; + + expectTrackedChangeOperation( + operationFrom(fragment, '/ed-fi/schoolYearTypes/deletes', 'get'), + 'EdFi_SchoolYear_TrackedChangeDelete', + ); + expectTrackedChangeOperation( + operationFrom(fragment, '/ed-fi/schoolYearTypes/keyChanges', 'get'), + 'EdFi_SchoolYear_TrackedChangeKeyChange', + ); + }); + }); + describe('when enhancing an abstract domain entity', () => { const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); metaEd.plugin.set('edfiApiSchema', newPluginEnvironment()); @@ -209,6 +597,52 @@ describe('OpenApiResourceFragmentEnhancer', () => { }); }); + describe('when enhancing a concrete abstract resource subclass', () => { + const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); + metaEd.plugin.set('edfiApiSchema', newPluginEnvironment()); + const namespaceName = 'EdFi'; + let namespace: Namespace; + + beforeAll(() => { + MetaEdTextBuilder.build() + .withBeginNamespace(namespaceName) + .withStartAbstractEntity('EducationOrganization') + .withDocumentation('Base education organization') + .withIntegerIdentity('EducationOrganizationId', 'doc') + .withEndAbstractEntity() + .withStartDomainEntitySubclass('School', 'EducationOrganization') + .withDocumentation('A school') + .withIntegerIdentityRename('SchoolId', 'EducationOrganizationId', 'doc') + .withEndDomainEntitySubclass() + .withEndNamespace() + .sendToListener(new NamespaceBuilder(metaEd, [])) + .sendToListener(new DomainEntityBuilder(metaEd, [])) + .sendToListener(new DomainEntitySubclassBuilder(metaEd, [])); + + domainEntityReferenceEnhancer(metaEd); + domainEntitySubclassBaseClassEnhancer(metaEd); + runPrerequisiteEnhancers(metaEd); + enhance(metaEd); + + namespace = metaEd.namespace.get(namespaceName) as Namespace; + }); + + it('should add tracked-change delete and key-change paths to concrete subclass endpoints', () => { + const school = namespace.entity.domainEntitySubclass.get('School') as TopLevelEntity; + const schoolApiData = school.data.edfiApiSchema; + const fragment = schoolApiData.openApiFragments[OpenApiDocumentType.RESOURCES] as OpenApiFragment; + + expectTrackedChangeOperation( + operationFrom(fragment, '/ed-fi/schools/deletes', 'get'), + 'EdFi_School_TrackedChangeDelete', + ); + expectTrackedChangeOperation( + operationFrom(fragment, '/ed-fi/schools/keyChanges', 'get'), + 'EdFi_School_TrackedChangeKeyChange', + ); + }); + }); + describe('when ApiSchemaBuildingEnhancer runs after fragments are created', () => { const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); metaEd.plugin.set('edfiApiSchema', newPluginEnvironment()); @@ -316,6 +750,119 @@ describe('OpenApiResourceFragmentEnhancer', () => { // Extension with no real collected properties should not produce exts expect(fragment?.exts).toBeUndefined(); }); + + it('should not add standalone live Change Query filters for resource extension overlays', () => { + const studentExtension = extensionNamespace.entity.domainEntityExtension.get('Student'); + const entityApiData = studentExtension.data.edfiApiSchema; + const fragment = entityApiData.openApiFragments.resources; + + expect(fragment?.paths).toBeUndefined(); + expect(JSON.stringify(fragment)).not.toContain('minChangeVersion'); + expect(JSON.stringify(fragment)).not.toContain('maxChangeVersion'); + }); + }); + + describe('when enhancing extension-defined top-level entities', () => { + const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); + metaEd.plugin.set('edfiApiSchema', newPluginEnvironment()); + const coreNamespaceName = 'EdFi'; + const extensionNamespaceName = 'SampleExtension'; + let extensionNamespace: Namespace; + + beforeAll(() => { + MetaEdTextBuilder.build() + .withBeginNamespace(coreNamespaceName) + .withStartDomainEntity('School') + .withDocumentation('A school') + .withIntegerIdentity('SchoolId', 'doc') + .withEndDomainEntity() + .withEndNamespace() + .sendToListener(new NamespaceBuilder(metaEd, [])) + .sendToListener(new DomainEntityBuilder(metaEd, [])); + + MetaEdTextBuilder.build() + .withBeginNamespace(extensionNamespaceName, extensionNamespaceName) + .withStartDomainEntity('BusRoute') + .withDocumentation('A bus route') + .withIntegerIdentity('BusRouteId', 'doc') + .withEndDomainEntity() + .withStartDescriptor('TransportationMode') + .withDocumentation('Transportation mode descriptor') + .withEndDescriptor() + .withEndNamespace() + .sendToListener(new NamespaceBuilder(metaEd, [])) + .sendToListener(new DomainEntityBuilder(metaEd, [])) + .sendToListener(new DescriptorBuilder(metaEd, [])); + + const coreNamespace = metaEd.namespace.get(coreNamespaceName) as Namespace; + extensionNamespace = metaEd.namespace.get(extensionNamespaceName) as Namespace; + extensionNamespace.dependencies.push(coreNamespace); + + domainEntityReferenceEnhancer(metaEd); + descriptorReferenceEnhancer(metaEd); + runPrerequisiteEnhancers(metaEd); + enhance(metaEd); + }); + + it('should add live Change Query filters to extension-defined resource GET-many operations', () => { + const busRoute = extensionNamespace.entity.domainEntity.get('BusRoute') as TopLevelEntity; + const busRouteApiData = busRoute.data.edfiApiSchema; + const fragment = busRouteApiData.openApiFragments[OpenApiDocumentType.RESOURCES] as OpenApiFragment; + + expectLiveChangeVersionFilterParameters(operationFrom(fragment, '/sample-extension/busRoutes', 'get')); + }); + + it('should add tracked-change paths to extension-defined resource operations', () => { + const busRoute = extensionNamespace.entity.domainEntity.get('BusRoute') as TopLevelEntity; + const busRouteApiData = busRoute.data.edfiApiSchema; + const fragment = busRouteApiData.openApiFragments[OpenApiDocumentType.RESOURCES] as OpenApiFragment; + const trackedChangeSchemaNames: string[] = Object.keys(fragment.components.schemas) + .filter((schemaName: string) => schemaName.includes('_TrackedChange')) + .sort(); + + expectTrackedChangeOperation( + operationFrom(fragment, '/sample-extension/busRoutes/deletes', 'get'), + 'SampleExtension_BusRoute_TrackedChangeDelete', + ); + expectTrackedChangeOperation( + operationFrom(fragment, '/sample-extension/busRoutes/keyChanges', 'get'), + 'SampleExtension_BusRoute_TrackedChangeKeyChange', + ); + expect(trackedChangeSchemaNames).toEqual([ + 'SampleExtension_BusRoute_TrackedChangeDelete', + 'SampleExtension_BusRoute_TrackedChangeKey', + 'SampleExtension_BusRoute_TrackedChangeKeyChange', + ]); + trackedChangeSchemaNames.forEach((schemaName: string) => { + expect(schemaName).not.toContain('_readable'); + expect(schemaName).not.toContain('_writable'); + }); + }); + + it('should add live Change Query filters to extension-defined descriptor GET-many operations', () => { + const transportationMode = extensionNamespace.entity.descriptor.get('TransportationMode') as TopLevelEntity; + const transportationModeApiData = transportationMode.data.edfiApiSchema; + const fragment = transportationModeApiData.openApiFragments[OpenApiDocumentType.DESCRIPTORS] as OpenApiFragment; + + expectLiveChangeVersionFilterParameters( + operationFrom(fragment, '/sample-extension/transportationModeDescriptors', 'get'), + ); + }); + + it('should add tracked-change paths to extension-defined descriptor operations', () => { + const transportationMode = extensionNamespace.entity.descriptor.get('TransportationMode') as TopLevelEntity; + const transportationModeApiData = transportationMode.data.edfiApiSchema; + const fragment = transportationModeApiData.openApiFragments[OpenApiDocumentType.DESCRIPTORS] as OpenApiFragment; + + expectTrackedChangeOperation( + operationFrom(fragment, '/sample-extension/transportationModeDescriptors/deletes', 'get'), + 'SampleExtension_TransportationModeDescriptor_TrackedChangeDelete', + ); + expectTrackedChangeOperation( + operationFrom(fragment, '/sample-extension/transportationModeDescriptors/keyChanges', 'get'), + 'SampleExtension_TransportationModeDescriptor_TrackedChangeKeyChange', + ); + }); }); describe('when testing projectEndpointName transformation', () => { diff --git a/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.test.ts b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.test.ts new file mode 100644 index 000000000..d72c4d3a8 --- /dev/null +++ b/packages/metaed-plugin-edfi-api-schema/test/enhancer/OpenApiTrackedChangeKeyFieldEnhancer.test.ts @@ -0,0 +1,420 @@ +// 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 { + DescriptorBuilder, + DomainEntityBuilder, + EnumerationBuilder, + MetaEdEnvironment, + MetaEdTextBuilder, + Namespace, + NamespaceBuilder, + TopLevelEntity, + newMetaEdEnvironment, + newPluginEnvironment, +} from '@edfi/metaed-core'; +import { + domainEntityReferenceEnhancer, + enumerationReferenceEnhancer, + mergeDirectiveEnhancer, +} from '@edfi/metaed-plugin-edfi-unified'; +import { enhance as entityPropertyApiSchemaDataSetupEnhancer } from '../../src/model/EntityPropertyApiSchemaData'; +import { enhance as entityApiSchemaDataSetupEnhancer } from '../../src/model/EntityApiSchemaData'; +import { enhance as namespaceSetupEnhancer } from '../../src/model/Namespace'; +import { enhance as subclassPropertyNamingCollisionEnhancer } from '../../src/enhancer/SubclassPropertyNamingCollisionEnhancer'; +import { enhance as referenceComponentEnhancer } from '../../src/enhancer/ReferenceComponentEnhancer'; +import { enhance as apiPropertyMappingEnhancer } from '../../src/enhancer/ApiPropertyMappingEnhancer'; +import { enhance as propertyCollectingEnhancer } from '../../src/enhancer/PropertyCollectingEnhancer'; +import { enhance as subclassPropertyCollectingEnhancer } from '../../src/enhancer/SubclassPropertyCollectingEnhancer'; +import { enhance as apiEntityMappingEnhancer } from '../../src/enhancer/ApiEntityMappingEnhancer'; +import { enhance as subclassApiEntityMappingEnhancer } from '../../src/enhancer/SubclassApiEntityMappingEnhancer'; +import { enhance as mergeCoveringFlattenedIdentityPropertyEnhancer } from '../../src/enhancer/MergeCoveringFlattenedIdentityPropertyEnhancer'; +import { enhance as resourceNameEnhancer } from '../../src/enhancer/ResourceNameEnhancer'; +import { enhance as jsonSchemaForInsertEnhancer } from '../../src/enhancer/JsonSchemaForInsertEnhancer'; +import { enhance as allJsonPathsMappingEnhancer } from '../../src/enhancer/AllJsonPathsMappingEnhancer'; +import { enhance as mergeJsonPathsMappingEnhancer } from '../../src/enhancer/MergeJsonPathsMappingEnhancer'; +import { enhance as mergeDirectiveEqualityConstraintEnhancer } from '../../src/enhancer/MergeDirectiveEqualityConstraintEnhancer'; +import { enhance as documentPathsMappingEnhancer } from '../../src/enhancer/DocumentPathsMappingEnhancer'; +import { enhance as identityFullnameEnhancer } from '../../src/enhancer/IdentityFullnameEnhancer'; +import { enhance as subclassIdentityFullnameEnhancer } from '../../src/enhancer/SubclassIdentityFullnameEnhancer'; +import { enhance as queryFieldMappingEnhancer } from '../../src/enhancer/QueryFieldMappingEnhancer'; +import { enhance as identityJsonPathsEnhancer } from '../../src/enhancer/IdentityJsonPathsEnhancer'; +import { enhance as openApiTrackedChangeKeyFieldEnhancer } from '../../src/enhancer/OpenApiTrackedChangeKeyFieldEnhancer'; +import { + createTrackedChangeSchemasFrom, + trackedChangeSchemaNamesFor, +} from '../../src/enhancer/OpenApiChangeQuerySchemaBuilder'; +import type { EntityApiSchemaData } from '../../src/model/EntityApiSchemaData'; +import type { SchemaObject, Schemas } from '../../src/model/OpenApiTypes'; +import type { TrackedChangeKeyField } from '../../src/model/TrackedChangeKeyField'; +import { metaEdPluginEnhancers } from '../integration/PluginHelper'; + +/** + * Runs the enhancers required before tracked-change key fields can be derived. + */ +function runPrerequisiteEnhancers(metaEd: MetaEdEnvironment): void { + domainEntityReferenceEnhancer(metaEd); + enumerationReferenceEnhancer(metaEd); + mergeDirectiveEnhancer(metaEd); + entityPropertyApiSchemaDataSetupEnhancer(metaEd); + entityApiSchemaDataSetupEnhancer(metaEd); + referenceComponentEnhancer(metaEd); + apiPropertyMappingEnhancer(metaEd); + propertyCollectingEnhancer(metaEd); + apiEntityMappingEnhancer(metaEd); + mergeCoveringFlattenedIdentityPropertyEnhancer(metaEd); +} + +/** + * Runs the enhancers needed to compare tracked-change key fields to query field mapping. + */ +function runInvariantEnhancers(metaEd: MetaEdEnvironment): void { + metaEdPluginEnhancers().forEach((enhancer) => enhancer(metaEd)); + namespaceSetupEnhancer(metaEd); + entityPropertyApiSchemaDataSetupEnhancer(metaEd); + entityApiSchemaDataSetupEnhancer(metaEd); + subclassPropertyNamingCollisionEnhancer(metaEd); + referenceComponentEnhancer(metaEd); + apiPropertyMappingEnhancer(metaEd); + propertyCollectingEnhancer(metaEd); + subclassPropertyCollectingEnhancer(metaEd); + apiEntityMappingEnhancer(metaEd); + subclassApiEntityMappingEnhancer(metaEd); + mergeCoveringFlattenedIdentityPropertyEnhancer(metaEd); + openApiTrackedChangeKeyFieldEnhancer(metaEd); + resourceNameEnhancer(metaEd); + jsonSchemaForInsertEnhancer(metaEd); + allJsonPathsMappingEnhancer(metaEd); + mergeJsonPathsMappingEnhancer(metaEd); + mergeDirectiveEqualityConstraintEnhancer(metaEd); + documentPathsMappingEnhancer(metaEd); + identityFullnameEnhancer(metaEd); + subclassIdentityFullnameEnhancer(metaEd); + queryFieldMappingEnhancer(metaEd); + identityJsonPathsEnhancer(metaEd); +} + +/** + * Returns the public tracked-change key field names from entity data. + */ +function trackedChangeKeyFieldNamesFrom(entity: TopLevelEntity): string[] { + const entityApiSchemaData: EntityApiSchemaData = entity.data.edfiApiSchema as EntityApiSchemaData; + return entityApiSchemaData.trackedChangeKeyFields.map( + (trackedChangeKeyField: TrackedChangeKeyField) => trackedChangeKeyField.fieldName, + ); +} + +/** + * Returns whether the entity query field mapping contains a public query field. + */ +function queryFieldMappingHasField(entity: TopLevelEntity, fieldName: string): boolean { + const entityApiSchemaData: EntityApiSchemaData = entity.data.edfiApiSchema as EntityApiSchemaData; + return entityApiSchemaData.queryFieldMapping[fieldName] != null; +} + +/** + * Expects tracked-change key fields to use the same public names as identity query fields. + */ +function expectTrackedChangeKeyFieldsToMatchQueryFieldMapping(entity: TopLevelEntity, expectedFieldNames: string[]): void { + expectedFieldNames.forEach((fieldName: string) => { + expect(queryFieldMappingHasField(entity, fieldName)).toBe(true); + }); + + expect(trackedChangeKeyFieldNamesFrom(entity)).toEqual(expectedFieldNames); +} + +/** + * Expects descriptor tracked-change schema keys to use public descriptor query field names. + */ +function expectTrackedChangeSchemaFieldsToMatchQueryFieldMapping( + entity: TopLevelEntity, + expectedFieldNames: string[], +): void { + expectedFieldNames.forEach((fieldName: string) => { + expect(queryFieldMappingHasField(entity, fieldName)).toBe(true); + }); + + const trackedChangeSchemas: Schemas = createTrackedChangeSchemasFrom(entity); + const keySchemaName: string = trackedChangeSchemaNamesFor(entity).keyValues; + const keySchema: SchemaObject = trackedChangeSchemas[keySchemaName] as SchemaObject; + + expect(Object.keys(keySchema.properties ?? {})).toEqual(expectedFieldNames); + expect(keySchema.required).toEqual(expectedFieldNames); +} + +describe('OpenApiTrackedChangeKeyFieldEnhancer', () => { + describe('when CourseOffering has a merged School identity through Session', () => { + const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); + const namespaceName = 'EdFi'; + let namespace: Namespace; + + beforeAll(() => { + MetaEdTextBuilder.build() + .withBeginNamespace(namespaceName) + .withStartDomainEntity('CourseOffering') + .withDocumentation('doc') + .withStringIdentity('LocalCourseCode', 'doc', '30') + .withDomainEntityIdentity('School', 'doc') + .withDomainEntityIdentity('Session', 'doc') + .withMergeDirective('School', 'Session.School') + .withEndDomainEntity() + + .withStartDomainEntity('Session') + .withDocumentation('doc') + .withStringIdentity('SessionName', 'doc', '30') + .withEnumerationIdentity('SchoolYear', 'doc') + .withDomainEntityIdentity('School', 'doc') + .withEndDomainEntity() + + .withStartDomainEntity('School') + .withDocumentation('doc') + .withIntegerIdentity('SchoolId', 'doc') + .withEndDomainEntity() + .withEndNamespace() + .sendToListener(new NamespaceBuilder(metaEd, [])) + .sendToListener(new DomainEntityBuilder(metaEd, [])); + + namespace = metaEd.namespace.get(namespaceName) as Namespace; + + runPrerequisiteEnhancers(metaEd); + openApiTrackedChangeKeyFieldEnhancer(metaEd); + }); + + it('should derive public tracked-change key fields from merge-aware identity metadata', () => { + const entity = namespace.entity.domainEntity.get('CourseOffering') as TopLevelEntity; + const { trackedChangeKeyFields } = entity.data.edfiApiSchema as EntityApiSchemaData; + + expect(trackedChangeKeyFields.map((field: TrackedChangeKeyField) => field.fieldName)).toMatchInlineSnapshot(` + Array [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + ] + `); + }); + + it('should create tracked-change key schemas from the derived public key fields', () => { + const entity = namespace.entity.domainEntity.get('CourseOffering') as TopLevelEntity; + + expect(createTrackedChangeSchemasFrom(entity).EdFi_CourseOffering_TrackedChangeKey).toMatchInlineSnapshot(` + Object { + "properties": Object { + "localCourseCode": Object { + "maxLength": 30, + "type": "string", + }, + "schoolId": Object { + "format": "int32", + "type": "integer", + }, + "schoolYear": Object { + "format": "int32", + "type": "integer", + }, + "sessionName": Object { + "maxLength": 30, + "type": "string", + }, + }, + "required": Array [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName", + ], + "type": "object", + } + `); + }); + }); + + describe('when non-merged-away identity fields produce the same public key field name', () => { + it('should fail rather than silently choosing one source property', () => { + const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); + const namespaceName = 'EdFi'; + + MetaEdTextBuilder.build() + .withBeginNamespace(namespaceName) + .withStartDomainEntity('Student') + .withDocumentation('doc') + .withStringIdentity('UniqueId', 'doc', '30', null, 'Student') + .withEndDomainEntity() + + .withStartDomainEntity('Grade') + .withDocumentation('doc') + .withDomainEntityIdentity('Student', 'doc') + .withIntegerIdentity('StudentUniqueId', 'doc') + .withEndDomainEntity() + .withEndNamespace() + .sendToListener(new NamespaceBuilder(metaEd, [])) + .sendToListener(new DomainEntityBuilder(metaEd, [])); + + runPrerequisiteEnhancers(metaEd); + + expect(() => openApiTrackedChangeKeyFieldEnhancer(metaEd)).toThrow( + 'Tracked-change key field name collision for EdFi.Grade: studentUniqueId is produced by multiple non-merged-away identity properties with different schemas.', + ); + }); + }); + + describe('when comparing tracked-change key fields to query field mapping', () => { + it('should keep merge-aware identity names aligned', () => { + const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); + metaEd.plugin.set('edfiApiSchema', newPluginEnvironment()); + const namespaceName = 'EdFi'; + + MetaEdTextBuilder.build() + .withBeginNamespace(namespaceName) + .withStartDomainEntity('CourseOffering') + .withDocumentation('doc') + .withStringIdentity('LocalCourseCode', 'doc', '30') + .withDomainEntityIdentity('School', 'doc') + .withDomainEntityIdentity('Session', 'doc') + .withMergeDirective('School', 'Session.School') + .withEndDomainEntity() + + .withStartDomainEntity('Session') + .withDocumentation('doc') + .withStringIdentity('SessionName', 'doc', '30') + .withEnumerationIdentity('SchoolYear', 'doc') + .withDomainEntityIdentity('School', 'doc') + .withEndDomainEntity() + + .withStartDomainEntity('School') + .withDocumentation('doc') + .withIntegerIdentity('SchoolId', 'doc') + .withEndDomainEntity() + + .withStartEnumeration('SchoolYear') + .withDocumentation('doc') + .withEnumerationItem('2022') + .withEndEnumeration() + .withEndNamespace() + .sendToListener(new NamespaceBuilder(metaEd, [])) + .sendToListener(new EnumerationBuilder(metaEd, [])) + .sendToListener(new DomainEntityBuilder(metaEd, [])); + + domainEntityReferenceEnhancer(metaEd); + enumerationReferenceEnhancer(metaEd); + mergeDirectiveEnhancer(metaEd); + runInvariantEnhancers(metaEd); + + const namespace: Namespace = metaEd.namespace.get(namespaceName) as Namespace; + const entity: TopLevelEntity = namespace.entity.domainEntity.get('CourseOffering') as TopLevelEntity; + + expectTrackedChangeKeyFieldsToMatchQueryFieldMapping(entity, [ + 'localCourseCode', + 'schoolId', + 'schoolYear', + 'sessionName', + ]); + }); + + it('should keep USI to UniqueId identity names aligned', () => { + const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); + metaEd.plugin.set('edfiApiSchema', newPluginEnvironment()); + const namespaceName = 'EdFi'; + + MetaEdTextBuilder.build() + .withBeginNamespace(namespaceName) + .withStartDomainEntity('Student') + .withDocumentation('doc') + .withStringIdentity('UniqueId', 'doc', '30', null, 'Student') + .withEndDomainEntity() + + .withStartDomainEntity('Grade') + .withDocumentation('doc') + .withDomainEntityIdentity('Student', 'doc') + .withEndDomainEntity() + .withEndNamespace() + .sendToListener(new NamespaceBuilder(metaEd, [])) + .sendToListener(new DomainEntityBuilder(metaEd, [])); + + domainEntityReferenceEnhancer(metaEd); + runInvariantEnhancers(metaEd); + + const namespace: Namespace = metaEd.namespace.get(namespaceName) as Namespace; + const entity: TopLevelEntity = namespace.entity.domainEntity.get('Grade') as TopLevelEntity; + + expectTrackedChangeKeyFieldsToMatchQueryFieldMapping(entity, ['studentUniqueId']); + }); + + it('should keep role-name-prefixed identity names aligned', () => { + const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); + metaEd.plugin.set('edfiApiSchema', newPluginEnvironment()); + const namespaceName = 'EdFi'; + + MetaEdTextBuilder.build() + .withBeginNamespace(namespaceName) + .withStartDomainEntity('Student') + .withDocumentation('doc') + .withStringIdentity('UniqueId', 'doc', '30', null, 'Student') + .withEndDomainEntity() + + .withStartDomainEntity('Grade') + .withDocumentation('doc') + .withDomainEntityIdentity('Student', 'doc') + .withDomainEntityIdentity('Student', 'doc', 'Tutoring') + .withEndDomainEntity() + .withEndNamespace() + .sendToListener(new NamespaceBuilder(metaEd, [])) + .sendToListener(new DomainEntityBuilder(metaEd, [])); + + domainEntityReferenceEnhancer(metaEd); + runInvariantEnhancers(metaEd); + + const namespace: Namespace = metaEd.namespace.get(namespaceName) as Namespace; + const entity: TopLevelEntity = namespace.entity.domainEntity.get('Grade') as TopLevelEntity; + + expectTrackedChangeKeyFieldsToMatchQueryFieldMapping(entity, ['studentUniqueId', 'tutoringStudentUniqueId']); + }); + + it('should keep descriptor identity schema names aligned', () => { + const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); + metaEd.plugin.set('edfiApiSchema', newPluginEnvironment()); + const namespaceName = 'EdFi'; + + MetaEdTextBuilder.build() + .withBeginNamespace(namespaceName) + .withStartDescriptor('GradeLevel') + .withDocumentation('doc') + .withEndDescriptor() + .withEndNamespace() + .sendToListener(new NamespaceBuilder(metaEd, [])) + .sendToListener(new DescriptorBuilder(metaEd, [])); + + runInvariantEnhancers(metaEd); + + const namespace: Namespace = metaEd.namespace.get(namespaceName) as Namespace; + const entity: TopLevelEntity = namespace.entity.descriptor.get('GradeLevel') as TopLevelEntity; + + expectTrackedChangeSchemaFieldsToMatchQueryFieldMapping(entity, ['namespace', 'codeValue']); + }); + + it('should keep SchoolYearType identity names aligned', () => { + const metaEd: MetaEdEnvironment = newMetaEdEnvironment(); + metaEd.plugin.set('edfiApiSchema', newPluginEnvironment()); + const namespaceName = 'EdFi'; + + MetaEdTextBuilder.build() + .withBeginNamespace(namespaceName) + .withStartEnumeration('SchoolYear') + .withDocumentation('doc') + .withEnumerationItem('2022') + .withEndEnumeration() + .withEndNamespace() + .sendToListener(new NamespaceBuilder(metaEd, [])) + .sendToListener(new EnumerationBuilder(metaEd, [])); + + runInvariantEnhancers(metaEd); + + const namespace: Namespace = metaEd.namespace.get(namespaceName) as Namespace; + const entity: TopLevelEntity = namespace.entity.schoolYearEnumeration.get('SchoolYear') as TopLevelEntity; + + expectTrackedChangeKeyFieldsToMatchQueryFieldMapping(entity, ['schoolYear']); + }); + }); +}); diff --git a/packages/metaed-plugin-edfi-api-schema/test/integration/OpenApiGeneratedDocumentValidation.test.ts b/packages/metaed-plugin-edfi-api-schema/test/integration/OpenApiGeneratedDocumentValidation.test.ts new file mode 100644 index 000000000..939650b01 --- /dev/null +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/OpenApiGeneratedDocumentValidation.test.ts @@ -0,0 +1,500 @@ +// 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 SwaggerParser from '@apidevtools/swagger-parser'; +import { + buildMetaEd, + buildParseTree, + initializeNamespaces, + loadFileIndex, + loadFiles, + loadPluginConfiguration, + newMetaEdConfiguration, + newState, + runEnhancers, + runGenerators, + setupPlugins, + type GeneratedOutput, + type GeneratorResult, + type MetaEdProject, + type SemVer, + type State, + walkBuilders, +} from '@edfi/metaed-core'; +import type { OpenAPI } from 'openapi-types'; +import type { ComponentsObject, Document, Schemas, TagObject } from '../../src/model/OpenApiTypes'; +import { OpenApiDocumentType, type OpenApiDocumentTypeValue } from '../../src/model/api-schema/OpenApiDocumentType'; +import type { OpenApiFragment } from '../../src/model/api-schema/OpenApiFragment'; +import { metaEdPlugins } from './PluginHelper'; + +jest.setTimeout(120000); + +const API_SCHEMA_GENERATOR_NAME = 'edfiApiSchema.ApiSchemaGenerator'; +const AVAILABLE_CHANGE_VERSIONS_PATH = '/availableChangeVersions'; +const GRADE_LEVEL_DESCRIPTOR_PATH = '/ed-fi/gradeLevelDescriptors'; +const STUDENT_RESOURCE_PATH = '/ed-fi/students'; + +/** + * OpenAPI base documents keyed by API metadata document type. + */ +type OpenApiBaseDocuments = { + [documentType in OpenApiDocumentTypeValue]?: Document; +}; + +/** + * Abstract resource OpenAPI data carried in generated ApiSchema artifacts. + */ +type AbstractResourceArtifact = { + openApiFragment?: OpenApiFragment; +}; + +/** + * Resource OpenAPI data carried in generated ApiSchema artifacts. + */ +type ResourceSchemaArtifact = { + openApiFragments: { + [documentType in OpenApiDocumentTypeValue]?: OpenApiFragment; + }; +}; + +/** + * Project OpenAPI data carried in generated ApiSchema artifacts. + */ +type ProjectSchemaArtifact = { + abstractResources: { [resourceName: string]: AbstractResourceArtifact }; + isExtensionProject: boolean; + openApiBaseDocuments?: OpenApiBaseDocuments; + projectName: string; + resourceSchemas: { [endpointName: string]: ResourceSchemaArtifact }; +}; + +/** + * Generated ApiSchema artifact shape needed by this validation. + */ +type ApiSchemaArtifact = { + projectSchema: ProjectSchemaArtifact; +}; + +/** + * OpenAPI document with initialized mutable components for composition. + */ +type ComposedOpenApiDocument = Document & { + components: ComponentsObject & { + parameters: NonNullable; + responses: NonNullable; + schemas: Schemas; + }; + tags: TagObject[]; +}; + +/** + * Project inputs needed to generate ApiSchema artifacts for a validation scenario. + */ +type ValidationGroup = { + dataStandardVersion: SemVer; + defaultPluginTechVersion: SemVer; + projectPaths: string[]; + projects: MetaEdProject[]; + scenarioName: string; +}; + +/** + * Groups of MetaEd projects that compose into served OpenAPI documents. + */ +const validationGroups: ValidationGroup[] = [ + { + dataStandardVersion: '5.0.0', + defaultPluginTechVersion: '7.1.0', + projectPaths: ['./node_modules/@edfi/ed-fi-model-5.0/'], + projects: [ + { + projectName: 'Ed-Fi', + namespaceName: 'EdFi', + projectExtension: '', + projectVersion: '5.0.0', + description: 'The Ed-Fi Data Standard v5.0', + }, + ], + scenarioName: 'ODS/API 7.1 data standard 5.0', + }, + { + dataStandardVersion: '5.1.0', + defaultPluginTechVersion: '7.2.0', + projectPaths: ['./node_modules/@edfi/ed-fi-model-5.1/', path.resolve(__dirname, './tpdm-project')], + projects: [ + { + projectName: 'Ed-Fi', + namespaceName: 'EdFi', + projectExtension: '', + projectVersion: '5.1.0', + description: 'The Ed-Fi Data Standard v5.1', + }, + { + projectName: 'TPDM', + namespaceName: 'TPDM', + projectExtension: 'TPDM', + projectVersion: '1.1.0', + description: 'TPDM-Core', + }, + ], + scenarioName: 'ODS/API 7.2 data standard 5.1 with TPDM', + }, + { + dataStandardVersion: '5.2.0', + defaultPluginTechVersion: '7.3.0', + projectPaths: [ + './node_modules/@edfi/ed-fi-model-5.2/', + path.resolve(__dirname, './homograph-project'), + path.resolve(__dirname, './sample-project'), + path.resolve(__dirname, './tpdm-project'), + ], + projects: [ + { + projectName: 'Ed-Fi', + namespaceName: 'EdFi', + projectExtension: '', + projectVersion: '5.2.0', + description: 'The Ed-Fi Data Standard v5.2', + }, + { + projectName: 'Homograph', + namespaceName: 'Homograph', + projectExtension: 'Homograph', + projectVersion: '1.0.0', + description: 'Homograph', + }, + { + projectName: 'Sample', + namespaceName: 'Sample', + projectExtension: 'Sample', + projectVersion: '1.1.0', + description: 'Sample-Core', + }, + { + projectName: 'TPDM', + namespaceName: 'TPDM', + projectExtension: 'TPDM', + projectVersion: '1.1.0', + description: 'TPDM-Core', + }, + ], + scenarioName: 'ODS/API 7.3 data standard 5.2 with extensions', + }, + { + dataStandardVersion: '6.0.0', + defaultPluginTechVersion: '7.3.0', + projectPaths: [ + './node_modules/@edfi/ed-fi-model-6.0/', + path.resolve(__dirname, './homograph-project'), + path.resolve(__dirname, './sample-project'), + ], + projects: [ + { + projectName: 'Ed-Fi', + namespaceName: 'EdFi', + projectExtension: '', + projectVersion: '6.0.0', + description: 'The Ed-Fi Data Standard v6.0', + }, + { + projectName: 'Homograph', + namespaceName: 'Homograph', + projectExtension: 'Homograph', + projectVersion: '1.0.0', + description: 'Homograph', + }, + { + projectName: 'Sample', + namespaceName: 'Sample', + projectExtension: 'Sample', + projectVersion: '1.1.0', + description: 'Sample-Core', + }, + ], + scenarioName: 'ODS/API 7.3 data standard 6.0 with extensions', + }, + { + dataStandardVersion: '6.1.0', + defaultPluginTechVersion: '7.3.0', + projectPaths: [ + './node_modules/@edfi/ed-fi-model-6.1/', + path.resolve(__dirname, './homograph-project'), + path.resolve(__dirname, './sample-project'), + ], + projects: [ + { + projectName: 'Ed-Fi', + namespaceName: 'EdFi', + projectExtension: '', + projectVersion: '6.1.0', + description: 'The Ed-Fi Data Standard v6.1', + }, + { + projectName: 'Homograph', + namespaceName: 'Homograph', + projectExtension: 'Homograph', + projectVersion: '1.0.0', + description: 'Homograph', + }, + { + projectName: 'Sample', + namespaceName: 'Sample', + projectExtension: 'Sample', + projectVersion: '1.1.0', + description: 'Sample-Core', + }, + ], + scenarioName: 'ODS/API 7.3 data standard 6.1 with extensions', + }, +]; + +/** + * Parses a generated ApiSchema artifact from generator output. + */ +function apiSchemaArtifactFrom(generatedOutput: GeneratedOutput): ApiSchemaArtifact { + return JSON.parse(generatedOutput.resultString); +} + +/** + * Generates ApiSchema artifacts for a validation group using the full MetaEd pipeline. + */ +async function generatedApiSchemaArtifactsFor(validationGroup: ValidationGroup): Promise { + const state: State = { + ...newState(), + metaEdConfiguration: { + ...newMetaEdConfiguration(), + artifactDirectory: './MetaEdOutput/', + defaultPluginTechVersion: validationGroup.defaultPluginTechVersion, + pluginConfigDirectories: [path.resolve(__dirname)], + projectPaths: validationGroup.projectPaths, + projects: validationGroup.projects, + }, + metaEdPlugins: metaEdPlugins(), + }; + state.metaEd.dataStandardVersion = validationGroup.dataStandardVersion; + + setupPlugins(state); + loadFiles(state); + loadFileIndex(state); + buildParseTree(buildMetaEd, state); + await walkBuilders(state); + initializeNamespaces(state); + await loadPluginConfiguration(state); + // eslint-disable-next-line no-restricted-syntax + for (const metaEdPlugin of state.metaEdPlugins) { + await runEnhancers(metaEdPlugin, state); + await runGenerators(metaEdPlugin, state); + } + + const generatorResult: GeneratorResult = state.generatorResults.filter( + (result: GeneratorResult): boolean => result.generatorName === API_SCHEMA_GENERATOR_NAME, + )[0]; + + expect(generatorResult.generatedOutput).toHaveLength(validationGroup.projects.length); + + return generatorResult.generatedOutput.map(apiSchemaArtifactFrom); +} + +/** + * Returns the generated core ApiSchema artifact and fails the test if it is missing. + */ +function coreArtifactFrom(apiSchemaArtifacts: ApiSchemaArtifact[]): ApiSchemaArtifact { + const coreArtifacts: ApiSchemaArtifact[] = apiSchemaArtifacts.filter( + (apiSchemaArtifact: ApiSchemaArtifact): boolean => !apiSchemaArtifact.projectSchema.isExtensionProject, + ); + + expect(coreArtifacts).toHaveLength(1); + + return coreArtifacts[0]; +} + +/** + * Returns the generated extension ApiSchema artifacts. + */ +function extensionArtifactsFrom(apiSchemaArtifacts: ApiSchemaArtifact[]): ApiSchemaArtifact[] { + return apiSchemaArtifacts.filter( + (apiSchemaArtifact: ApiSchemaArtifact): boolean => apiSchemaArtifact.projectSchema.isExtensionProject, + ); +} + +/** + * Creates a composed OpenAPI document with components and tags safe for merge operations. + */ +function newComposedOpenApiDocument(baseDocument: Document): ComposedOpenApiDocument { + return { + ...baseDocument, + components: { + ...(baseDocument.components ?? {}), + parameters: { ...(baseDocument.components?.parameters ?? {}) }, + responses: { ...(baseDocument.components?.responses ?? {}) }, + schemas: { ...(baseDocument.components?.schemas ?? {}) }, + }, + paths: { ...baseDocument.paths }, + tags: [...(baseDocument.tags ?? [])], + }; +} + +/** + * Returns OpenAPI tags by name for deterministic duplicate suppression. + */ +function tagsByNameFrom(tags: TagObject[]): Map { + return new Map(tags.map((tag: TagObject): [string, TagObject] => [tag.name, tag])); +} + +/** + * Composes a base OpenAPI document with all compatible project fragments for one document type. + */ +function composeOpenApiDocument( + baseDocument: Document, + projectSchemas: ProjectSchemaArtifact[], + documentType: OpenApiDocumentTypeValue, +): Document { + const document: ComposedOpenApiDocument = newComposedOpenApiDocument(baseDocument); + const tagsByName: Map = tagsByNameFrom(document.tags); + + projectSchemas.forEach((projectSchema: ProjectSchemaArtifact): void => { + if (documentType === OpenApiDocumentType.RESOURCES) { + Object.values(projectSchema.abstractResources).forEach((abstractResource: AbstractResourceArtifact): void => { + Object.assign(document.components.schemas, abstractResource.openApiFragment?.components.schemas ?? {}); + }); + } + + Object.values(projectSchema.resourceSchemas).forEach((resourceSchema: ResourceSchemaArtifact): void => { + const fragment: OpenApiFragment | undefined = resourceSchema.openApiFragments[documentType]; + + Object.assign(document.components.schemas, fragment?.components.schemas ?? {}); + Object.assign(document.paths, fragment?.paths ?? {}); + (fragment?.tags ?? []).forEach((tag: TagObject): void => { + tagsByName.set(tag.name, tag); + }); + }); + }); + + return { + ...document, + tags: Array.from(tagsByName.values()), + }; +} + +/** + * Returns the core OpenAPI base documents and fails the test if they are missing. + */ +function openApiBaseDocumentsFrom(apiSchemaArtifact: ApiSchemaArtifact): OpenApiBaseDocuments { + expect(apiSchemaArtifact.projectSchema.openApiBaseDocuments).toBeDefined(); + + return apiSchemaArtifact.projectSchema.openApiBaseDocuments as OpenApiBaseDocuments; +} + +/** + * Validates a generated OpenAPI document with the parser's own OpenAPI type boundary. + */ +async function validateOpenApiDocument(document: Document): Promise { + return SwaggerParser.validate(document as unknown as OpenAPI.Document); +} + +/** + * Asserts a composed OpenAPI document includes a GET path. + */ +function expectGetPath(document: Document, pathName: string): void { + expect(document.paths[pathName]?.get).toBeDefined(); +} + +/** + * Asserts the standalone Change Queries document contains only the fixed availableChangeVersions route. + */ +function expectStandaloneChangeQueriesDocument(changeQueriesBaseDocument: Document): void { + expect(Object.keys(changeQueriesBaseDocument.paths)).toEqual([AVAILABLE_CHANGE_VERSIONS_PATH]); + expect(changeQueriesBaseDocument.paths[AVAILABLE_CHANGE_VERSIONS_PATH]?.get).toBeDefined(); + expect(changeQueriesBaseDocument.paths[`${STUDENT_RESOURCE_PATH}/deletes`]).toBeUndefined(); + expect(changeQueriesBaseDocument.paths[`${STUDENT_RESOURCE_PATH}/keyChanges`]).toBeUndefined(); + expect(changeQueriesBaseDocument.paths[`${GRADE_LEVEL_DESCRIPTOR_PATH}/deletes`]).toBeUndefined(); + expect(changeQueriesBaseDocument.paths[`${GRADE_LEVEL_DESCRIPTOR_PATH}/keyChanges`]).toBeUndefined(); +} + +/** + * Asserts resource-scoped tracked-change paths remain in the resource and descriptor OpenAPI documents. + */ +function expectTrackedChangePathsInResourceDocuments(resourcesDocument: Document, descriptorsDocument: Document): void { + expect(resourcesDocument.paths[AVAILABLE_CHANGE_VERSIONS_PATH]).toBeUndefined(); + expect(descriptorsDocument.paths[AVAILABLE_CHANGE_VERSIONS_PATH]).toBeUndefined(); + expectGetPath(resourcesDocument, `${STUDENT_RESOURCE_PATH}/deletes`); + expectGetPath(resourcesDocument, `${STUDENT_RESOURCE_PATH}/keyChanges`); + expectGetPath(descriptorsDocument, `${GRADE_LEVEL_DESCRIPTOR_PATH}/deletes`); + expectGetPath(descriptorsDocument, `${GRADE_LEVEL_DESCRIPTOR_PATH}/keyChanges`); +} + +/** + * Asserts extension projects do not carry core OpenAPI base documents. + */ +function expectNoExtensionBaseDocuments(extensionArtifacts: ApiSchemaArtifact[]): void { + extensionArtifacts.forEach((extensionArtifact: ApiSchemaArtifact): void => { + expect(extensionArtifact.projectSchema.openApiBaseDocuments).toBeUndefined(); + }); +} + +/** + * Asserts resource schemas do not expose a changeQueries fragment document type. + */ +function expectNoChangeQueriesFragments(projectSchemas: ProjectSchemaArtifact[]): void { + projectSchemas.forEach((projectSchema: ProjectSchemaArtifact): void => { + Object.values(projectSchema.resourceSchemas).forEach((resourceSchema: ResourceSchemaArtifact): void => { + expect(resourceSchema.openApiFragments[OpenApiDocumentType.CHANGE_QUERIES]).toBeUndefined(); + }); + }); +} + +describe('generated OpenAPI documents', (): void => { + describe.each(validationGroups)('$scenarioName', (validationGroup: ValidationGroup): void => { + let apiSchemaArtifacts: ApiSchemaArtifact[] = []; + + beforeAll(async (): Promise => { + apiSchemaArtifacts = await generatedApiSchemaArtifactsFor(validationGroup); + }); + + it('should validate OpenAPI documents and preserve Change Query path distribution', async (): Promise => { + const coreArtifact: ApiSchemaArtifact = coreArtifactFrom(apiSchemaArtifacts); + const extensionArtifacts: ApiSchemaArtifact[] = extensionArtifactsFrom(apiSchemaArtifacts); + const projectSchemas: ProjectSchemaArtifact[] = [ + coreArtifact.projectSchema, + ...extensionArtifacts.map( + (extensionArtifact: ApiSchemaArtifact): ProjectSchemaArtifact => extensionArtifact.projectSchema, + ), + ]; + const openApiBaseDocuments: OpenApiBaseDocuments = openApiBaseDocumentsFrom(coreArtifact); + const changeQueriesBaseDocument: Document | undefined = openApiBaseDocuments[OpenApiDocumentType.CHANGE_QUERIES]; + const descriptorsBaseDocument: Document | undefined = openApiBaseDocuments[OpenApiDocumentType.DESCRIPTORS]; + const resourcesBaseDocument: Document | undefined = openApiBaseDocuments[OpenApiDocumentType.RESOURCES]; + + expect(changeQueriesBaseDocument).toBeDefined(); + expect(descriptorsBaseDocument).toBeDefined(); + expect(resourcesBaseDocument).toBeDefined(); + + const descriptorsDocument: Document = composeOpenApiDocument( + descriptorsBaseDocument as Document, + projectSchemas, + OpenApiDocumentType.DESCRIPTORS, + ); + const resourcesDocument: Document = composeOpenApiDocument( + resourcesBaseDocument as Document, + projectSchemas, + OpenApiDocumentType.RESOURCES, + ); + + expectStandaloneChangeQueriesDocument(changeQueriesBaseDocument as Document); + expectTrackedChangePathsInResourceDocuments(resourcesDocument, descriptorsDocument); + expectNoExtensionBaseDocuments(extensionArtifacts); + expectNoChangeQueriesFragments(projectSchemas); + + const documentsToValidate: Document[] = [ + changeQueriesBaseDocument as Document, + descriptorsDocument, + resourcesDocument, + ]; + + await Promise.all(documentsToValidate.map(validateOpenApiDocument)); + }); + }); +}); diff --git a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_1/ds-5.0-api-schema-authoritative.json b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_1/ds-5.0-api-schema-authoritative.json index f8fed5b5c..019296cce 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_1/ds-5.0-api-schema-authoritative.json +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_1/ds-5.0-api-schema-authoritative.json @@ -976,6 +976,66 @@ ], "isExtensionProject": false, "openApiBaseDocuments": { + "changeQueries": { + "components": { + "parameters": { + }, + "responses": { + }, + "schemas": { + } + }, + "info": { + "contact": { + "url": "https://www.ed-fi.org/what-is-ed-fi/contact/" + }, + "description": "The Ed-Fi DMS API enables applications to read and write education data stored in an Ed-Fi DMS through a secure REST interface. \n***\n > *Note: Consumers of DMS information should sanitize all data for display and storage. DMS provides reasonable safeguards against cross-site scripting attacks and other malicious content, but the platform does not and cannot guarantee that the data it contains is free of all potentially harmful content.* \n***\n", + "title": "Ed-Fi Data Management Service API", + "version": "1" + }, + "openapi": "3.0.0", + "paths": { + "/availableChangeVersions": { + "get": { + "operationId": "getAvailableChangeVersions", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "newestChangeVersion": { + "format": "int64", + "type": "integer" + }, + "oldestChangeVersion": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "oldestChangeVersion", + "newestChangeVersion" + ], + "type": "object" + } + } + }, + "description": "The available change version range was successfully retrieved." + } + }, + "summary": "Retrieves the available change version range." + } + } + }, + "servers": [ + { + "url": "" + } + ], + "tags": [ + ] + }, "descriptors": { "components": { "parameters": { @@ -1001,6 +1061,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1010,6 +1071,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1124,9 +1186,6 @@ "NotFound": { "description": "The resource could not be found." }, - "NotFoundUseSnapshot": { - "description": "The resource could not be found. If Use-Snapshot header is set to true, this response can indicate the snapshot may have been removed." - }, "NotModified": { "description": "The resource's current server-side ETag value matched the If-None-Match header value supplied with the request indicating the resource has not been modified." }, @@ -1187,6 +1246,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1196,6 +1256,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1310,9 +1371,6 @@ "NotFound": { "description": "The resource could not be found." }, - "NotFoundUseSnapshot": { - "description": "The resource could not be found. If Use-Snapshot header is set to true, this response can indicate the snapshot may have been removed." - }, "NotModified": { "description": "The resource's current server-side ETag value matched the If-None-Match header value supplied with the request indicating the resource has not been modified." }, @@ -1836,6 +1894,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AbsenceEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -1952,7 +2071,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1995,7 +2114,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2015,6 +2134,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/absenceEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAbsenceEventCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "absenceEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/absenceEventCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAbsenceEventCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "absenceEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/absenceEventCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -2050,7 +2287,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2082,15 +2319,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -2117,7 +2345,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2174,7 +2402,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2399,6 +2627,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AcademicHonorCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -2515,7 +2804,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2558,7 +2847,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2578,27 +2867,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/academicHonorCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAcademicHonorCategoriesById", + "/ed-fi/academicHonorCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicHonorCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2612,48 +2914,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "academicHonorCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/academicHonorCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAcademicHonorCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicHonorCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -2661,14 +2952,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2680,20 +2971,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "academicHonorCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAcademicHonorCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/academicHonorCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAcademicHonorCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -2708,18 +3003,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AcademicHonorCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AcademicHonorCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -2737,7 +3020,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "academicHonorCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAcademicHonorCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "academicHonorCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAcademicHonorCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AcademicHonorCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AcademicHonorCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2962,6 +3360,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AcademicSubjectDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AcademicSubjectDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AcademicSubjectDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3078,7 +3537,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3121,7 +3580,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3141,27 +3600,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/academicSubjectDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAcademicSubjectsById", + "/ed-fi/academicSubjectDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicSubjectsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3175,48 +3647,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "academicSubjectDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/academicSubjectDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAcademicSubjectsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicSubjectsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -3224,14 +3685,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3243,20 +3704,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "academicSubjectDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAcademicSubject", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/academicSubjectDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAcademicSubjectsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -3271,18 +3736,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" - } - } - }, - "description": "The JSON representation of the AcademicSubject resource to be created or updated.", - "required": true, - "x-bodyName": "AcademicSubject" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -3300,7 +3753,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "academicSubjectDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAcademicSubjectsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "academicSubjectDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAcademicSubject", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" + } + } + }, + "description": "The JSON representation of the AcademicSubject resource to be created or updated.", + "required": true, + "x-bodyName": "AcademicSubject" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3588,6 +4156,68 @@ "weekIdentifier" ], "type": "object" + }, + "EdFi_AcademicWeek_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AcademicWeek_TrackedChangeKey": { + "properties": { + "schoolId": { + "format": "int64", + "type": "integer" + }, + "weekIdentifier": { + "maxLength": 80, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "schoolId", + "weekIdentifier" + ], + "type": "object" + }, + "EdFi_AcademicWeek_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3696,7 +4326,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3739,7 +4369,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3760,27 +4390,40 @@ "SchoolCalendar" ] }, - "/ed-fi/academicWeeks/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAcademicWeeksById", + "/ed-fi/academicWeeks/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicWeeksDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3794,48 +4437,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "academicWeeks" ] }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/academicWeeks/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAcademicWeeksById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicWeeksKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -3843,14 +4476,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AcademicWeek" + "items": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3862,20 +4495,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "academicWeeks" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAcademicWeek", + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/academicWeeks/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAcademicWeeksById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -3890,18 +4528,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AcademicWeek" - } - } - }, - "description": "The JSON representation of the AcademicWeek resource to be created or updated.", - "required": true, - "x-bodyName": "AcademicWeek" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -3919,7 +4545,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "academicWeeks" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAcademicWeeksById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicWeek" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "academicWeeks" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAcademicWeek", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicWeek" + } + } + }, + "description": "The JSON representation of the AcademicWeek resource to be created or updated.", + "required": true, + "x-bodyName": "AcademicWeek" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4142,6 +4883,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AccommodationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccommodationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AccommodationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -4258,7 +5060,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4301,7 +5103,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4321,27 +5123,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/accommodationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAccommodationsById", + "/ed-fi/accommodationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccommodationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4355,48 +5170,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "accommodationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/accommodationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAccommodationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccommodationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -4404,14 +5208,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AccommodationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4423,20 +5227,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "accommodationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAccommodation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/accommodationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAccommodationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -4451,18 +5259,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AccommodationDescriptor" - } - } - }, - "description": "The JSON representation of the Accommodation resource to be created or updated.", - "required": true, - "x-bodyName": "Accommodation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -4480,7 +5276,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "accommodationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAccommodationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "accommodationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAccommodation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor" + } + } + }, + "description": "The JSON representation of the Accommodation resource to be created or updated.", + "required": true, + "x-bodyName": "Accommodation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4705,6 +5616,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AccountTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccountTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AccountTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -4821,7 +5793,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4864,7 +5836,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4884,27 +5856,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/accountTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAccountTypesById", + "/ed-fi/accountTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccountTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4918,48 +5903,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "accountTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/accountTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAccountTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccountTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -4967,14 +5941,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4986,20 +5960,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "accountTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAccountType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/accountTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAccountTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -5014,18 +5992,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor" - } - } - }, - "description": "The JSON representation of the AccountType resource to be created or updated.", - "required": true, - "x-bodyName": "AccountType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -5043,7 +6009,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "accountTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAccountTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "accountTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAccountType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor" + } + } + }, + "description": "The JSON representation of the AccountType resource to be created or updated.", + "required": true, + "x-bodyName": "AccountType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5398,6 +6479,73 @@ "schoolYear" ], "type": "object" + }, + "EdFi_AccountabilityRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccountabilityRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "ratingTitle": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "educationOrganizationId", + "ratingTitle", + "schoolYear" + ], + "type": "object" + }, + "EdFi_AccountabilityRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -5528,7 +6676,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5571,7 +6719,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5593,27 +6741,40 @@ "Enrollment" ] }, - "/ed-fi/accountabilityRatings/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAccountabilityRatingsById", + "/ed-fi/accountabilityRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccountabilityRatingsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -5627,48 +6788,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "accountabilityRatings" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment" + ] + }, + "/ed-fi/accountabilityRatings/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAccountabilityRatingsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccountabilityRatingsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -5676,14 +6828,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AccountabilityRating" + "items": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -5695,20 +6847,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "accountabilityRatings" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAccountabilityRating", + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment" + ] + }, + "/ed-fi/accountabilityRatings/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAccountabilityRatingsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -5723,18 +6881,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AccountabilityRating" - } - } - }, - "description": "The JSON representation of the AccountabilityRating resource to be created or updated.", - "required": true, - "x-bodyName": "AccountabilityRating" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -5752,7 +6898,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "accountabilityRatings" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAccountabilityRatingsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "accountabilityRatings" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAccountabilityRating", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating" + } + } + }, + "description": "The JSON representation of the AccountabilityRating resource to be created or updated.", + "required": true, + "x-bodyName": "AccountabilityRating" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5988,6 +7249,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AchievementCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AchievementCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AchievementCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -6104,7 +7426,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6147,7 +7469,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6167,27 +7489,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/achievementCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAchievementCategoriesById", + "/ed-fi/achievementCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAchievementCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6201,48 +7536,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "achievementCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/achievementCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAchievementCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAchievementCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -6250,14 +7574,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6269,20 +7593,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "achievementCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAchievementCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/achievementCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAchievementCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -6297,18 +7625,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AchievementCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AchievementCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -6326,7 +7642,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "achievementCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAchievementCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "achievementCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAchievementCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AchievementCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AchievementCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6551,6 +7982,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AdditionalCreditTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -6667,7 +8159,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6710,7 +8202,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6730,27 +8222,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/additionalCreditTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAdditionalCreditTypesById", + "/ed-fi/additionalCreditTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAdditionalCreditTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6764,48 +8269,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "additionalCreditTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/additionalCreditTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAdditionalCreditTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAdditionalCreditTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -6813,14 +8307,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6832,20 +8326,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "additionalCreditTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAdditionalCreditType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/additionalCreditTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAdditionalCreditTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -6860,18 +8358,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor" - } - } - }, - "description": "The JSON representation of the AdditionalCreditType resource to be created or updated.", - "required": true, - "x-bodyName": "AdditionalCreditType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -6889,7 +8375,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "additionalCreditTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAdditionalCreditTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "additionalCreditTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAdditionalCreditType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor" + } + } + }, + "description": "The JSON representation of the AdditionalCreditType resource to be created or updated.", + "required": true, + "x-bodyName": "AdditionalCreditType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7114,6 +8715,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AddressTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AddressTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AddressTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -7230,7 +8892,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7273,7 +8935,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7293,27 +8955,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/addressTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAddressTypesById", + "/ed-fi/addressTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAddressTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7327,48 +9002,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "addressTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/addressTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAddressTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAddressTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -7376,14 +9040,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7395,20 +9059,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "addressTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAddressType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/addressTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAddressTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -7423,18 +9091,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor" - } - } - }, - "description": "The JSON representation of the AddressType resource to be created or updated.", - "required": true, - "x-bodyName": "AddressType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -7452,7 +9108,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "addressTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAddressTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "addressTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAddressType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor" + } + } + }, + "description": "The JSON representation of the AddressType resource to be created or updated.", + "required": true, + "x-bodyName": "AddressType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7677,6 +9448,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AdministrationEnvironmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -7793,7 +9625,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7836,7 +9668,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7856,27 +9688,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/administrationEnvironmentDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAdministrationEnvironmentsById", + "/ed-fi/administrationEnvironmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrationEnvironmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7890,48 +9735,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "administrationEnvironmentDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/administrationEnvironmentDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAdministrationEnvironmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrationEnvironmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -7939,14 +9773,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7958,20 +9792,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "administrationEnvironmentDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAdministrationEnvironment", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/administrationEnvironmentDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAdministrationEnvironmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -7986,18 +9824,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor" - } - } - }, - "description": "The JSON representation of the AdministrationEnvironment resource to be created or updated.", - "required": true, - "x-bodyName": "AdministrationEnvironment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -8015,7 +9841,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "administrationEnvironmentDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAdministrationEnvironmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "administrationEnvironmentDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAdministrationEnvironment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor" + } + } + }, + "description": "The JSON representation of the AdministrationEnvironment resource to be created or updated.", + "required": true, + "x-bodyName": "AdministrationEnvironment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8240,6 +10181,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AdministrativeFundingControlDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -8356,7 +10358,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8399,7 +10401,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8419,27 +10421,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/administrativeFundingControlDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAdministrativeFundingControlsById", + "/ed-fi/administrativeFundingControlDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrativeFundingControlsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -8453,48 +10468,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "administrativeFundingControlDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/administrativeFundingControlDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAdministrativeFundingControlsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrativeFundingControlsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -8502,14 +10506,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -8521,20 +10525,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "administrativeFundingControlDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAdministrativeFundingControl", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/administrativeFundingControlDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAdministrativeFundingControlsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -8549,18 +10557,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor" - } - } - }, - "description": "The JSON representation of the AdministrativeFundingControl resource to be created or updated.", - "required": true, - "x-bodyName": "AdministrativeFundingControl" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -8578,7 +10574,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "administrativeFundingControlDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAdministrativeFundingControlsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "administrativeFundingControlDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAdministrativeFundingControl", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor" + } + } + }, + "description": "The JSON representation of the AdministrativeFundingControl resource to be created or updated.", + "required": true, + "x-bodyName": "AdministrativeFundingControl" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8803,6 +10914,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AncestryEthnicOriginDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -8919,7 +11091,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8962,7 +11134,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8982,27 +11154,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/ancestryEthnicOriginDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAncestryEthnicOriginsById", + "/ed-fi/ancestryEthnicOriginDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAncestryEthnicOriginsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -9016,48 +11201,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "ancestryEthnicOriginDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ancestryEthnicOriginDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAncestryEthnicOriginsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAncestryEthnicOriginsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -9065,14 +11239,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -9084,20 +11258,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "ancestryEthnicOriginDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAncestryEthnicOrigin", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ancestryEthnicOriginDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAncestryEthnicOriginsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -9112,18 +11290,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor" - } - } - }, - "description": "The JSON representation of the AncestryEthnicOrigin resource to be created or updated.", - "required": true, - "x-bodyName": "AncestryEthnicOrigin" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -9141,7 +11307,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "ancestryEthnicOriginDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAncestryEthnicOriginsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "ancestryEthnicOriginDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAncestryEthnicOrigin", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor" + } + } + }, + "description": "The JSON representation of the AncestryEthnicOrigin resource to be created or updated.", + "required": true, + "x-bodyName": "AncestryEthnicOrigin" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9366,6 +11647,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -9482,7 +11824,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9525,7 +11867,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9545,27 +11887,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentCategoriesById", + "/ed-fi/assessmentCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -9579,48 +11934,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -9628,14 +11972,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -9647,20 +11991,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -9675,18 +12023,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -9704,7 +12040,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9929,6 +12380,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -10045,7 +12557,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10088,7 +12600,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10108,27 +12620,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentIdentificationSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentIdentificationSystemsById", + "/ed-fi/assessmentIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentIdentificationSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -10142,48 +12667,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentIdentificationSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentIdentificationSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentIdentificationSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentIdentificationSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -10191,14 +12705,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -10210,20 +12724,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentIdentificationSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentIdentificationSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentIdentificationSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentIdentificationSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -10238,18 +12756,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentIdentificationSystem resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentIdentificationSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -10267,7 +12773,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentIdentificationSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentIdentificationSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentIdentificationSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentIdentificationSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentIdentificationSystem resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentIdentificationSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10492,6 +13113,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentItemCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -10608,7 +13290,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10651,7 +13333,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10671,27 +13353,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentItemCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentItemCategoriesById", + "/ed-fi/assessmentItemCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -10705,48 +13400,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentItemCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentItemCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentItemCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -10754,14 +13438,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -10773,20 +13457,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentItemCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentItemCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentItemCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentItemCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -10801,18 +13489,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentItemCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentItemCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -10830,7 +13506,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentItemCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentItemCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentItemCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentItemCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentItemCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentItemCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -11055,6 +13846,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentItemResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentItemResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentItemResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -11171,7 +14023,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -11214,7 +14066,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -11234,27 +14086,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentItemResultDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentItemResultsById", + "/ed-fi/assessmentItemResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemResultsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -11268,48 +14133,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentItemResultDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentItemResultDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentItemResultsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemResultsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -11317,14 +14171,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -11336,20 +14190,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentItemResultDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentItemResult", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentItemResultDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentItemResultsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -11364,18 +14222,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentItemResult resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentItemResult" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -11393,7 +14239,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentItemResultDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentItemResultsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentItemResultDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentItemResult", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentItemResult resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentItemResult" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -11922,6 +14883,75 @@ "identificationCode" ], "type": "object" + }, + "EdFi_AssessmentItem_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentItem_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "identificationCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "identificationCode", + "namespace" + ], + "type": "object" + }, + "EdFi_AssessmentItem_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -12072,7 +15102,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -12115,7 +15145,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -12137,27 +15167,40 @@ "AssessmentMetadata" ] }, - "/ed-fi/assessmentItems/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentItemsById", + "/ed-fi/assessmentItems/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -12171,48 +15214,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentItems" ] }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessmentItems/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentItemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -12220,14 +15254,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItem" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -12239,20 +15273,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentItems" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentItem", + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessmentItems/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentItemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -12267,18 +15307,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItem" - } - } - }, - "description": "The JSON representation of the AssessmentItem resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentItem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -12296,7 +15324,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentItems" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentItemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItem" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentItems" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentItem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItem" + } + } + }, + "description": "The JSON representation of the AssessmentItem resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentItem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -12541,6 +15684,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -12657,7 +15861,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -12700,7 +15904,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -12720,27 +15924,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentPeriodDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentPeriodsById", + "/ed-fi/assessmentPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentPeriodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -12754,48 +15971,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentPeriodDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentPeriodDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentPeriodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentPeriodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -12803,14 +16009,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -12822,20 +16028,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentPeriodDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentPeriod", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentPeriodDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentPeriodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -12850,18 +16060,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentPeriod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -12879,7 +16077,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentPeriodDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentPeriodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentPeriodDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentPeriod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentPeriod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -13104,6 +16417,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentReportingMethodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -13220,7 +16594,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -13263,7 +16637,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -13283,27 +16657,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentReportingMethodDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentReportingMethodsById", + "/ed-fi/assessmentReportingMethodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentReportingMethodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -13317,48 +16704,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentReportingMethodDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentReportingMethodDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentReportingMethodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentReportingMethodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -13366,14 +16742,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -13385,20 +16761,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentReportingMethodDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentReportingMethod", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentReportingMethodDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentReportingMethodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -13413,18 +16793,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentReportingMethod resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentReportingMethod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -13442,7 +16810,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentReportingMethodDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentReportingMethodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentReportingMethodDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentReportingMethod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentReportingMethod resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentReportingMethod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -13891,6 +17374,75 @@ "scoreRangeId" ], "type": "object" + }, + "EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "scoreRangeId": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "namespace", + "scoreRangeId" + ], + "type": "object" + }, + "EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -14024,7 +17576,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14067,7 +17619,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14087,27 +17639,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentScoreRangeLearningStandards/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentScoreRangeLearningStandardsById", + "/ed-fi/assessmentScoreRangeLearningStandards/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentScoreRangeLearningStandardsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -14121,48 +17686,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentScoreRangeLearningStandards" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentScoreRangeLearningStandards/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentScoreRangeLearningStandardsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentScoreRangeLearningStandardsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -14170,14 +17724,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -14189,20 +17743,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentScoreRangeLearningStandards" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentScoreRangeLearningStandard", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentScoreRangeLearningStandards/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentScoreRangeLearningStandardsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -14217,18 +17775,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard" - } - } - }, - "description": "The JSON representation of the AssessmentScoreRangeLearningStandard resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentScoreRangeLearningStandard" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -14246,7 +17792,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentScoreRangeLearningStandards" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentScoreRangeLearningStandardsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentScoreRangeLearningStandards" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentScoreRangeLearningStandard", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard" + } + } + }, + "description": "The JSON representation of the AssessmentScoreRangeLearningStandard resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentScoreRangeLearningStandard" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15822,6 +19483,69 @@ "sectionReference" ], "type": "object" + }, + "EdFi_Assessment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Assessment_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_Assessment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -15998,7 +19722,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16041,7 +19765,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16063,27 +19787,40 @@ "AssessmentMetadata" ] }, - "/ed-fi/assessments/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentsById", + "/ed-fi/assessments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -16097,48 +19834,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessments" ] }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessments/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -16146,14 +19874,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Assessment" + "items": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -16165,20 +19893,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessments" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessment", + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessments/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -16193,18 +19927,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Assessment" - } - } - }, - "description": "The JSON representation of the Assessment resource to be created or updated.", - "required": true, - "x-bodyName": "Assessment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -16222,7 +19944,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessments" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Assessment" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessments" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Assessment" + } + } + }, + "description": "The JSON representation of the Assessment resource to be created or updated.", + "required": true, + "x-bodyName": "Assessment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16494,6 +20331,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssignmentLateStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssignmentLateStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -16610,7 +20508,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16653,7 +20551,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16673,27 +20571,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assignmentLateStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssignmentLateStatusesById", + "/ed-fi/assignmentLateStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssignmentLateStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -16707,48 +20618,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assignmentLateStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assignmentLateStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssignmentLateStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssignmentLateStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -16756,14 +20656,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -16775,20 +20675,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assignmentLateStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssignmentLateStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assignmentLateStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssignmentLateStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -16803,18 +20707,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor" - } - } - }, - "description": "The JSON representation of the AssignmentLateStatus resource to be created or updated.", - "required": true, - "x-bodyName": "AssignmentLateStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -16832,7 +20724,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assignmentLateStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssignmentLateStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assignmentLateStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssignmentLateStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor" + } + } + }, + "description": "The JSON representation of the AssignmentLateStatus resource to be created or updated.", + "required": true, + "x-bodyName": "AssignmentLateStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17057,6 +21064,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AttemptStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AttemptStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AttemptStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -17173,7 +21241,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17216,7 +21284,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17236,27 +21304,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/attemptStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAttemptStatusesById", + "/ed-fi/attemptStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAttemptStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -17270,48 +21351,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "attemptStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/attemptStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAttemptStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAttemptStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -17319,14 +21389,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -17338,20 +21408,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "attemptStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAttemptStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/attemptStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAttemptStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -17366,18 +21440,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor" - } - } - }, - "description": "The JSON representation of the AttemptStatus resource to be created or updated.", - "required": true, - "x-bodyName": "AttemptStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -17395,7 +21457,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "attemptStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAttemptStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "attemptStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAttemptStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor" + } + } + }, + "description": "The JSON representation of the AttemptStatus resource to be created or updated.", + "required": true, + "x-bodyName": "AttemptStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17620,6 +21797,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AttendanceEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -17736,7 +21974,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17779,7 +22017,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17799,27 +22037,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/attendanceEventCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAttendanceEventCategoriesById", + "/ed-fi/attendanceEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAttendanceEventCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -17833,48 +22084,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "attendanceEventCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/attendanceEventCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAttendanceEventCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAttendanceEventCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -17882,14 +22122,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -17901,20 +22141,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "attendanceEventCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAttendanceEventCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/attendanceEventCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAttendanceEventCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -17929,18 +22173,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AttendanceEventCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AttendanceEventCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -17958,7 +22190,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "attendanceEventCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAttendanceEventCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "attendanceEventCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAttendanceEventCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AttendanceEventCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AttendanceEventCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18250,6 +22597,68 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_BalanceSheetDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BalanceSheetDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "minLength": 1, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_BalanceSheetDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -18341,7 +22750,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18384,7 +22793,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18405,27 +22814,40 @@ "Finance" ] }, - "/ed-fi/balanceSheetDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteBalanceSheetDimensionsById", + "/ed-fi/balanceSheetDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBalanceSheetDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -18439,48 +22861,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "balanceSheetDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/balanceSheetDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getBalanceSheetDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBalanceSheetDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -18488,14 +22900,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_BalanceSheetDimension" + "items": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -18507,20 +22919,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "balanceSheetDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putBalanceSheetDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/balanceSheetDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteBalanceSheetDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -18535,18 +22952,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_BalanceSheetDimension" - } - } - }, - "description": "The JSON representation of the BalanceSheetDimension resource to be created or updated.", - "required": true, - "x-bodyName": "BalanceSheetDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -18564,7 +22969,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "balanceSheetDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getBalanceSheetDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "balanceSheetDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putBalanceSheetDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension" + } + } + }, + "description": "The JSON representation of the BalanceSheetDimension resource to be created or updated.", + "required": true, + "x-bodyName": "BalanceSheetDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18771,6 +23291,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -18887,7 +23468,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18930,7 +23511,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18950,27 +23531,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/barrierToInternetAccessInResidenceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteBarrierToInternetAccessInResidencesById", + "/ed-fi/barrierToInternetAccessInResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBarrierToInternetAccessInResidencesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -18984,48 +23578,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "barrierToInternetAccessInResidenceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/barrierToInternetAccessInResidenceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getBarrierToInternetAccessInResidencesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBarrierToInternetAccessInResidencesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -19033,14 +23616,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -19052,20 +23635,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "barrierToInternetAccessInResidenceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putBarrierToInternetAccessInResidence", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/barrierToInternetAccessInResidenceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteBarrierToInternetAccessInResidencesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -19080,18 +23667,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor" - } - } - }, - "description": "The JSON representation of the BarrierToInternetAccessInResidence resource to be created or updated.", - "required": true, - "x-bodyName": "BarrierToInternetAccessInResidence" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -19109,7 +23684,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "barrierToInternetAccessInResidenceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getBarrierToInternetAccessInResidencesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "barrierToInternetAccessInResidenceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putBarrierToInternetAccessInResidence", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor" + } + } + }, + "description": "The JSON representation of the BarrierToInternetAccessInResidence resource to be created or updated.", + "required": true, + "x-bodyName": "BarrierToInternetAccessInResidence" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19334,6 +24024,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BehaviorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BehaviorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BehaviorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -19450,7 +24201,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19493,7 +24244,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19513,27 +24264,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/behaviorDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteBehaviorsById", + "/ed-fi/behaviorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBehaviorsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -19547,48 +24311,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "behaviorDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/behaviorDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getBehaviorsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBehaviorsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -19596,14 +24349,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_BehaviorDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -19615,20 +24368,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "behaviorDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putBehavior", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/behaviorDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteBehaviorsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -19643,18 +24400,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_BehaviorDescriptor" - } - } - }, - "description": "The JSON representation of the Behavior resource to be created or updated.", - "required": true, - "x-bodyName": "Behavior" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -19672,7 +24417,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "behaviorDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getBehaviorsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "behaviorDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putBehavior", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor" + } + } + }, + "description": "The JSON representation of the Behavior resource to be created or updated.", + "required": true, + "x-bodyName": "Behavior" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20163,6 +25023,68 @@ "schoolId" ], "type": "object" + }, + "EdFi_BellSchedule_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BellSchedule_TrackedChangeKey": { + "properties": { + "bellScheduleName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "bellScheduleName", + "schoolId" + ], + "type": "object" + }, + "EdFi_BellSchedule_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -20279,7 +25201,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20322,7 +25244,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20343,27 +25265,40 @@ "BellSchedule" ] }, - "/ed-fi/bellSchedules/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteBellSchedulesById", + "/ed-fi/bellSchedules/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBellSchedulesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20377,48 +25312,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "bellSchedules" ] }, + "x-Ed-Fi-domains": [ + "BellSchedule" + ] + }, + "/ed-fi/bellSchedules/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getBellSchedulesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBellSchedulesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -20426,14 +25351,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_BellSchedule" + "items": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20445,20 +25370,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "bellSchedules" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putBellSchedule", + "x-Ed-Fi-domains": [ + "BellSchedule" + ] + }, + "/ed-fi/bellSchedules/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteBellSchedulesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -20473,18 +25403,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_BellSchedule" - } - } - }, - "description": "The JSON representation of the BellSchedule resource to be created or updated.", - "required": true, - "x-bodyName": "BellSchedule" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -20502,7 +25420,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "bellSchedules" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getBellSchedulesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BellSchedule" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "bellSchedules" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putBellSchedule", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BellSchedule" + } + } + }, + "description": "The JSON representation of the BellSchedule resource to be created or updated.", + "required": true, + "x-bodyName": "BellSchedule" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20831,6 +25864,78 @@ "date" ], "type": "object" + }, + "EdFi_CalendarDate_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CalendarDate_TrackedChangeKey": { + "properties": { + "calendarCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "date": { + "format": "date", + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "calendarCode", + "date", + "schoolId", + "schoolYear" + ], + "type": "object" + }, + "EdFi_CalendarDate_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -20932,7 +26037,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20975,7 +26080,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20996,27 +26101,40 @@ "SchoolCalendar" ] }, - "/ed-fi/calendarDates/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCalendarDatesById", + "/ed-fi/calendarDates/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarDatesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -21030,48 +26148,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "calendarDates" ] }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendarDates/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCalendarDatesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarDatesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -21079,14 +26187,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CalendarDate" + "items": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -21098,20 +26206,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "calendarDates" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCalendarDate", + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendarDates/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCalendarDatesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -21126,18 +26239,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CalendarDate" - } - } - }, - "description": "The JSON representation of the CalendarDate resource to be created or updated.", - "required": true, - "x-bodyName": "CalendarDate" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -21155,7 +26256,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "calendarDates" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCalendarDatesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarDate" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "calendarDates" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCalendarDate", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarDate" + } + } + }, + "description": "The JSON representation of the CalendarDate resource to be created or updated.", + "required": true, + "x-bodyName": "CalendarDate" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21372,6 +26588,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CalendarEventDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CalendarEventDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CalendarEventDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -21488,7 +26765,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21531,7 +26808,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21551,27 +26828,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/calendarEventDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCalendarEventsById", + "/ed-fi/calendarEventDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -21585,48 +26875,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "calendarEventDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/calendarEventDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCalendarEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -21634,14 +26913,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -21653,20 +26932,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "calendarEventDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCalendarEvent", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/calendarEventDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCalendarEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -21681,18 +26964,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor" - } - } - }, - "description": "The JSON representation of the CalendarEvent resource to be created or updated.", - "required": true, - "x-bodyName": "CalendarEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -21710,7 +26981,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "calendarEventDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCalendarEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "calendarEventDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCalendarEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor" + } + } + }, + "description": "The JSON representation of the CalendarEvent resource to be created or updated.", + "required": true, + "x-bodyName": "CalendarEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21935,6 +27321,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CalendarTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CalendarTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CalendarTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -22051,7 +27498,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22094,7 +27541,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22114,27 +27561,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/calendarTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCalendarTypesById", + "/ed-fi/calendarTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -22148,48 +27608,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "calendarTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/calendarTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCalendarTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -22197,14 +27646,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -22216,20 +27665,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "calendarTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCalendarType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/calendarTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCalendarTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -22244,18 +27697,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CalendarType resource to be created or updated.", - "required": true, - "x-bodyName": "CalendarType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -22273,7 +27714,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "calendarTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCalendarTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "calendarTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCalendarType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CalendarType resource to be created or updated.", + "required": true, + "x-bodyName": "CalendarType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22623,6 +28179,73 @@ "schoolYear" ], "type": "object" + }, + "EdFi_Calendar_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Calendar_TrackedChangeKey": { + "properties": { + "calendarCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "calendarCode", + "schoolId", + "schoolYear" + ], + "type": "object" + }, + "EdFi_Calendar_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -22723,7 +28346,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22766,7 +28389,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22787,27 +28410,40 @@ "SchoolCalendar" ] }, - "/ed-fi/calendars/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCalendarsById", + "/ed-fi/calendars/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -22821,48 +28457,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "calendars" ] }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendars/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCalendarsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -22870,14 +28496,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Calendar" + "items": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -22889,20 +28515,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "calendars" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCalendar", + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendars/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCalendarsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -22917,18 +28548,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Calendar" - } - } - }, - "description": "The JSON representation of the Calendar resource to be created or updated.", - "required": true, - "x-bodyName": "Calendar" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -22946,7 +28565,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "calendars" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCalendarsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Calendar" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "calendars" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCalendar", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Calendar" + } + } + }, + "description": "The JSON representation of the Calendar resource to be created or updated.", + "required": true, + "x-bodyName": "Calendar" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23163,6 +28897,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CareerPathwayDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CareerPathwayDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CareerPathwayDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -23279,7 +29074,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23322,7 +29117,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23342,27 +29137,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/careerPathwayDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCareerPathwaysById", + "/ed-fi/careerPathwayDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCareerPathwaysDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -23376,48 +29184,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "careerPathwayDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/careerPathwayDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCareerPathwaysById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCareerPathwaysKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -23425,14 +29222,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -23444,20 +29241,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "careerPathwayDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCareerPathway", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/careerPathwayDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCareerPathwaysById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -23472,18 +29273,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor" - } - } - }, - "description": "The JSON representation of the CareerPathway resource to be created or updated.", - "required": true, - "x-bodyName": "CareerPathway" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -23501,7 +29290,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "careerPathwayDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCareerPathwaysById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "careerPathwayDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCareerPathway", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor" + } + } + }, + "description": "The JSON representation of the CareerPathway resource to be created or updated.", + "required": true, + "x-bodyName": "CareerPathway" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24301,6 +30205,73 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ChartOfAccount_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ChartOfAccount_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ChartOfAccount_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -24498,7 +30469,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24541,7 +30512,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24562,27 +30533,40 @@ "Finance" ] }, - "/ed-fi/chartOfAccounts/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteChartOfAccountsById", + "/ed-fi/chartOfAccounts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getChartOfAccountsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -24596,48 +30580,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "chartOfAccounts" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/chartOfAccounts/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getChartOfAccountsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getChartOfAccountsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -24645,14 +30619,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ChartOfAccount" + "items": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -24664,20 +30638,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "chartOfAccounts" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putChartOfAccount", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/chartOfAccounts/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteChartOfAccountsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -24692,18 +30671,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ChartOfAccount" - } - } - }, - "description": "The JSON representation of the ChartOfAccount resource to be created or updated.", - "required": true, - "x-bodyName": "ChartOfAccount" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -24721,7 +30688,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "chartOfAccounts" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getChartOfAccountsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "chartOfAccounts" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putChartOfAccount", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount" + } + } + }, + "description": "The JSON representation of the ChartOfAccount resource to be created or updated.", + "required": true, + "x-bodyName": "ChartOfAccount" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25004,6 +31086,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -25120,7 +31263,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25163,7 +31306,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25183,27 +31326,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/charterApprovalAgencyTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCharterApprovalAgencyTypesById", + "/ed-fi/charterApprovalAgencyTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCharterApprovalAgencyTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -25217,48 +31373,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "charterApprovalAgencyTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/charterApprovalAgencyTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCharterApprovalAgencyTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCharterApprovalAgencyTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -25266,14 +31411,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -25285,20 +31430,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "charterApprovalAgencyTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCharterApprovalAgencyType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/charterApprovalAgencyTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCharterApprovalAgencyTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -25313,18 +31462,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CharterApprovalAgencyType resource to be created or updated.", - "required": true, - "x-bodyName": "CharterApprovalAgencyType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -25342,7 +31479,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "charterApprovalAgencyTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCharterApprovalAgencyTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "charterApprovalAgencyTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCharterApprovalAgencyType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CharterApprovalAgencyType resource to be created or updated.", + "required": true, + "x-bodyName": "CharterApprovalAgencyType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25567,6 +31819,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CharterStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CharterStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CharterStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -25683,7 +31996,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25726,7 +32039,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25746,27 +32059,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/charterStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCharterStatusesById", + "/ed-fi/charterStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCharterStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -25780,48 +32106,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "charterStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/charterStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCharterStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCharterStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -25829,14 +32144,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -25848,20 +32163,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "charterStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCharterStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/charterStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCharterStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -25876,18 +32195,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor" - } - } - }, - "description": "The JSON representation of the CharterStatus resource to be created or updated.", - "required": true, - "x-bodyName": "CharterStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -25905,7 +32212,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "charterStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCharterStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "charterStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCharterStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor" + } + } + }, + "description": "The JSON representation of the CharterStatus resource to be created or updated.", + "required": true, + "x-bodyName": "CharterStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26130,6 +32552,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CitizenshipStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CitizenshipStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CitizenshipStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -26246,7 +32729,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -26289,7 +32772,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26309,27 +32792,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/citizenshipStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCitizenshipStatusesById", + "/ed-fi/citizenshipStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCitizenshipStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -26343,48 +32839,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "citizenshipStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/citizenshipStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCitizenshipStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCitizenshipStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -26392,14 +32877,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -26411,20 +32896,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "citizenshipStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCitizenshipStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/citizenshipStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCitizenshipStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -26439,18 +32928,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor" - } - } - }, - "description": "The JSON representation of the CitizenshipStatus resource to be created or updated.", - "required": true, - "x-bodyName": "CitizenshipStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -26468,7 +32945,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "citizenshipStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCitizenshipStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "citizenshipStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCitizenshipStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor" + } + } + }, + "description": "The JSON representation of the CitizenshipStatus resource to be created or updated.", + "required": true, + "x-bodyName": "CitizenshipStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26785,6 +33377,68 @@ "schoolId" ], "type": "object" + }, + "EdFi_ClassPeriod_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ClassPeriod_TrackedChangeKey": { + "properties": { + "classPeriodName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "classPeriodName", + "schoolId" + ], + "type": "object" + }, + "EdFi_ClassPeriod_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -26874,7 +33528,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -26917,7 +33571,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26940,27 +33594,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/classPeriods/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteClassPeriodsById", + "/ed-fi/classPeriods/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getClassPeriodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -26974,48 +33641,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "classPeriods" ] }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/classPeriods/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getClassPeriodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getClassPeriodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -27023,14 +33682,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ClassPeriod" + "items": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -27042,20 +33701,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "classPeriods" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putClassPeriod", + "x-Ed-Fi-domains": [ + "BellSchedule", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/classPeriods/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteClassPeriodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -27070,18 +33736,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ClassPeriod" - } - } - }, - "description": "The JSON representation of the ClassPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "ClassPeriod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -27099,7 +33753,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "classPeriods" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getClassPeriodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ClassPeriod" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "classPeriods" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putClassPeriod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ClassPeriod" + } + } + }, + "description": "The JSON representation of the ClassPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "ClassPeriod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27313,6 +34082,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ClassroomPositionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ClassroomPositionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ClassroomPositionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -27429,7 +34259,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27472,7 +34302,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27492,27 +34322,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/classroomPositionDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteClassroomPositionsById", + "/ed-fi/classroomPositionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getClassroomPositionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -27526,48 +34369,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "classroomPositionDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/classroomPositionDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getClassroomPositionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getClassroomPositionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -27575,14 +34407,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -27594,20 +34426,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "classroomPositionDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putClassroomPosition", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/classroomPositionDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteClassroomPositionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -27622,18 +34458,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor" - } - } - }, - "description": "The JSON representation of the ClassroomPosition resource to be created or updated.", - "required": true, - "x-bodyName": "ClassroomPosition" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -27651,7 +34475,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "classroomPositionDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getClassroomPositionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "classroomPositionDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putClassroomPosition", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor" + } + } + }, + "description": "The JSON representation of the ClassroomPosition resource to be created or updated.", + "required": true, + "x-bodyName": "ClassroomPosition" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27876,6 +34815,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CohortScopeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CohortScopeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CohortScopeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -27992,7 +34992,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28035,7 +35035,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28055,27 +35055,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/cohortScopeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCohortScopesById", + "/ed-fi/cohortScopeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortScopesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -28089,48 +35102,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "cohortScopeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortScopeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCohortScopesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortScopesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -28138,14 +35140,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -28157,20 +35159,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "cohortScopeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCohortScope", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortScopeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCohortScopesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -28185,18 +35191,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor" - } - } - }, - "description": "The JSON representation of the CohortScope resource to be created or updated.", - "required": true, - "x-bodyName": "CohortScope" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -28214,7 +35208,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "cohortScopeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCohortScopesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "cohortScopeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCohortScope", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor" + } + } + }, + "description": "The JSON representation of the CohortScope resource to be created or updated.", + "required": true, + "x-bodyName": "CohortScope" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28439,6 +35548,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CohortTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CohortTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CohortTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -28555,7 +35725,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28598,7 +35768,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28618,27 +35788,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/cohortTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCohortTypesById", + "/ed-fi/cohortTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -28652,48 +35835,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "cohortTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCohortTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -28701,14 +35873,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -28720,20 +35892,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "cohortTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCohortType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCohortTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -28748,18 +35924,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CohortType resource to be created or updated.", - "required": true, - "x-bodyName": "CohortType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -28777,7 +35941,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "cohortTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCohortTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "cohortTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCohortType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CohortType resource to be created or updated.", + "required": true, + "x-bodyName": "CohortType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29002,6 +36281,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CohortYearTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CohortYearTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CohortYearTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -29118,7 +36458,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29161,7 +36501,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29181,27 +36521,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/cohortYearTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCohortYearTypesById", + "/ed-fi/cohortYearTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortYearTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -29215,48 +36568,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "cohortYearTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortYearTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCohortYearTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortYearTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -29264,14 +36606,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -29283,20 +36625,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "cohortYearTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCohortYearType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortYearTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCohortYearTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -29311,18 +36657,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CohortYearType resource to be created or updated.", - "required": true, - "x-bodyName": "CohortYearType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -29340,7 +36674,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "cohortYearTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCohortYearTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "cohortYearTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCohortYearType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CohortYearType resource to be created or updated.", + "required": true, + "x-bodyName": "CohortYearType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29738,6 +37187,68 @@ "educationOrganizationId" ], "type": "object" + }, + "EdFi_Cohort_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Cohort_TrackedChangeKey": { + "properties": { + "cohortIdentifier": { + "maxLength": 36, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "cohortIdentifier", + "educationOrganizationId" + ], + "type": "object" + }, + "EdFi_Cohort_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -29856,7 +37367,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29899,7 +37410,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29921,27 +37432,40 @@ "StudentCohort" ] }, - "/ed-fi/cohorts/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCohortsById", + "/ed-fi/cohorts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -29955,48 +37479,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "cohorts" ] }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/cohorts/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCohortsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -30004,14 +37519,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Cohort" + "items": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -30023,20 +37538,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "cohorts" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCohort", + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/cohorts/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCohortsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -30051,18 +37572,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Cohort" - } - } - }, - "description": "The JSON representation of the Cohort resource to be created or updated.", - "required": true, - "x-bodyName": "Cohort" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -30080,7 +37589,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "cohorts" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCohortsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Cohort" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "cohorts" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCohort", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Cohort" + } + } + }, + "description": "The JSON representation of the Cohort resource to be created or updated.", + "required": true, + "x-bodyName": "Cohort" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31094,6 +38718,62 @@ ], "type": "object" }, + "EdFi_CommunityOrganization_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CommunityOrganization_TrackedChangeKey": { + "properties": { + "communityOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "communityOrganizationId" + ], + "type": "object" + }, + "EdFi_CommunityOrganization_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_EducationOrganization_Address": { "properties": { "addressTypeDescriptor": { @@ -31502,7 +39182,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31545,7 +39225,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31566,27 +39246,40 @@ "EducationOrganization" ] }, - "/ed-fi/communityOrganizations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCommunityOrganizationsById", + "/ed-fi/communityOrganizations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityOrganizationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -31600,48 +39293,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "communityOrganizations" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityOrganizations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCommunityOrganizationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityOrganizationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -31649,14 +39332,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CommunityOrganization" + "items": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -31668,20 +39351,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "communityOrganizations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCommunityOrganization", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityOrganizations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCommunityOrganizationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -31696,18 +39384,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CommunityOrganization" - } - } - }, - "description": "The JSON representation of the CommunityOrganization resource to be created or updated.", - "required": true, - "x-bodyName": "CommunityOrganization" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -31725,7 +39401,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "communityOrganizations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCommunityOrganizationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "communityOrganizations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCommunityOrganization", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization" + } + } + }, + "description": "The JSON representation of the CommunityOrganization resource to be created or updated.", + "required": true, + "x-bodyName": "CommunityOrganization" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -32147,6 +39938,73 @@ "licensingOrganization" ], "type": "object" + }, + "EdFi_CommunityProviderLicense_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CommunityProviderLicense_TrackedChangeKey": { + "properties": { + "communityProviderId": { + "format": "int64", + "type": "integer" + }, + "licenseIdentifier": { + "maxLength": 36, + "type": "string" + }, + "licensingOrganization": { + "maxLength": 75, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "communityProviderId", + "licenseIdentifier", + "licensingOrganization" + ], + "type": "object" + }, + "EdFi_CommunityProviderLicense_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -32310,7 +40168,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32353,7 +40211,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -32374,27 +40232,40 @@ "EducationOrganization" ] }, - "/ed-fi/communityProviderLicenses/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCommunityProviderLicensesById", + "/ed-fi/communityProviderLicenses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProviderLicensesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -32408,48 +40279,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "communityProviderLicenses" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityProviderLicenses/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCommunityProviderLicensesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProviderLicensesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -32457,14 +40318,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CommunityProviderLicense" + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -32476,20 +40337,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "communityProviderLicenses" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCommunityProviderLicense", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityProviderLicenses/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCommunityProviderLicensesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -32504,18 +40370,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CommunityProviderLicense" - } - } - }, - "description": "The JSON representation of the CommunityProviderLicense resource to be created or updated.", - "required": true, - "x-bodyName": "CommunityProviderLicense" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -32533,7 +40387,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "communityProviderLicenses" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCommunityProviderLicensesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "communityProviderLicenses" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCommunityProviderLicense", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense" + } + } + }, + "description": "The JSON representation of the CommunityProviderLicense resource to be created or updated.", + "required": true, + "x-bodyName": "CommunityProviderLicense" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -33704,6 +41673,62 @@ ], "type": "object" }, + "EdFi_CommunityProvider_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CommunityProvider_TrackedChangeKey": { + "properties": { + "communityProviderId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "communityProviderId" + ], + "type": "object" + }, + "EdFi_CommunityProvider_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_EducationOrganization_Address": { "properties": { "addressTypeDescriptor": { @@ -34165,7 +42190,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34208,7 +42233,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34229,27 +42254,40 @@ "EducationOrganization" ] }, - "/ed-fi/communityProviders/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCommunityProvidersById", + "/ed-fi/communityProviders/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProvidersDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -34263,48 +42301,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "communityProviders" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityProviders/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCommunityProvidersById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProvidersKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -34312,14 +42340,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CommunityProvider" + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -34331,20 +42359,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "communityProviders" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCommunityProvider", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityProviders/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCommunityProvidersById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -34359,18 +42392,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CommunityProvider" - } - } - }, - "description": "The JSON representation of the CommunityProvider resource to be created or updated.", - "required": true, - "x-bodyName": "CommunityProvider" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -34388,7 +42409,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "communityProviders" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCommunityProvidersById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityProvider" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "communityProviders" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCommunityProvider", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityProvider" + } + } + }, + "description": "The JSON representation of the CommunityProvider resource to be created or updated.", + "required": true, + "x-bodyName": "CommunityProvider" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34658,6 +42794,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CompetencyLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CompetencyLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CompetencyLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -34774,7 +42971,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34817,7 +43014,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34837,27 +43034,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/competencyLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCompetencyLevelsById", + "/ed-fi/competencyLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -34871,48 +43081,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "competencyLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/competencyLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCompetencyLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -34920,14 +43119,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -34939,20 +43138,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "competencyLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCompetencyLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/competencyLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCompetencyLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -34967,18 +43170,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor" - } - } - }, - "description": "The JSON representation of the CompetencyLevel resource to be created or updated.", - "required": true, - "x-bodyName": "CompetencyLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -34996,7 +43187,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "competencyLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCompetencyLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "competencyLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCompetencyLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor" + } + } + }, + "description": "The JSON representation of the CompetencyLevel resource to be created or updated.", + "required": true, + "x-bodyName": "CompetencyLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -35314,6 +43620,73 @@ "objectiveGradeLevelDescriptor" ], "type": "object" + }, + "EdFi_CompetencyObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CompetencyObjective_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "objective": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "objectiveGradeLevelDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor" + ], + "type": "object" + }, + "EdFi_CompetencyObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -35435,7 +43808,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35478,7 +43851,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -35500,27 +43873,40 @@ "ReportCard" ] }, - "/ed-fi/competencyObjectives/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCompetencyObjectivesById", + "/ed-fi/competencyObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyObjectivesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -35534,48 +43920,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "competencyObjectives" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/competencyObjectives/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCompetencyObjectivesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyObjectivesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -35583,14 +43960,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CompetencyObjective" + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -35602,20 +43979,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "competencyObjectives" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCompetencyObjective", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/competencyObjectives/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCompetencyObjectivesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -35630,18 +44013,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CompetencyObjective" - } - } - }, - "description": "The JSON representation of the CompetencyObjective resource to be created or updated.", - "required": true, - "x-bodyName": "CompetencyObjective" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -35659,7 +44030,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "competencyObjectives" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCompetencyObjectivesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "competencyObjectives" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCompetencyObjective", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective" + } + } + }, + "description": "The JSON representation of the CompetencyObjective resource to be created or updated.", + "required": true, + "x-bodyName": "CompetencyObjective" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -35889,6 +44375,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ContactTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContactTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ContactTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -36005,7 +44552,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36048,7 +44595,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -36068,27 +44615,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/contactTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteContactTypesById", + "/ed-fi/contactTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContactTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -36102,48 +44662,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "contactTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/contactTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getContactTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContactTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -36151,14 +44700,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -36170,20 +44719,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "contactTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putContactType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/contactTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteContactTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -36198,18 +44751,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ContactType resource to be created or updated.", - "required": true, - "x-bodyName": "ContactType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -36227,7 +44768,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "contactTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getContactTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "contactTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putContactType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ContactType resource to be created or updated.", + "required": true, + "x-bodyName": "ContactType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38033,6 +46689,63 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "EdFi_Contact_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Contact_TrackedChangeKey": { + "properties": { + "contactUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "contactUniqueId" + ], + "type": "object" + }, + "EdFi_Contact_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -38242,7 +46955,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38285,7 +46998,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38306,27 +47019,40 @@ "StudentIdentificationAndDemographics" ] }, - "/ed-fi/contacts/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteContactsById", + "/ed-fi/contacts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContactsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -38340,48 +47066,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "contacts" ] }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/contacts/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getContactsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContactsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -38389,14 +47105,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Contact" + "items": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -38408,20 +47124,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "contacts" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putContact", + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/contacts/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteContactsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -38436,18 +47157,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Contact" - } - } - }, - "description": "The JSON representation of the Contact resource to be created or updated.", - "required": true, - "x-bodyName": "Contact" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -38465,7 +47174,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "contacts" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getContactsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Contact" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "contacts" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putContact", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Contact" + } + } + }, + "description": "The JSON representation of the Contact resource to be created or updated.", + "required": true, + "x-bodyName": "Contact" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38753,6 +47577,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ContentClassDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContentClassDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ContentClassDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -38869,7 +47754,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38912,7 +47797,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38932,27 +47817,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/contentClassDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteContentClassesById", + "/ed-fi/contentClassDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContentClassesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -38966,48 +47864,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "contentClassDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/contentClassDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getContentClassesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContentClassesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -39015,14 +47902,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ContentClassDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -39034,20 +47921,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "contentClassDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putContentClass", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/contentClassDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteContentClassesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -39062,18 +47953,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ContentClassDescriptor" - } - } - }, - "description": "The JSON representation of the ContentClass resource to be created or updated.", - "required": true, - "x-bodyName": "ContentClass" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -39091,7 +47970,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "contentClassDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getContentClassesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "contentClassDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putContentClass", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor" + } + } + }, + "description": "The JSON representation of the ContentClass resource to be created or updated.", + "required": true, + "x-bodyName": "ContentClass" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -39316,6 +48310,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -39432,7 +48487,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39475,7 +48530,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -39495,27 +48550,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/continuationOfServicesReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteContinuationOfServicesReasonsById", + "/ed-fi/continuationOfServicesReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContinuationOfServicesReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -39529,48 +48597,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "continuationOfServicesReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/continuationOfServicesReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getContinuationOfServicesReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContinuationOfServicesReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -39578,14 +48635,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -39597,20 +48654,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "continuationOfServicesReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putContinuationOfServicesReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/continuationOfServicesReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteContinuationOfServicesReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -39625,18 +48686,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor" - } - } - }, - "description": "The JSON representation of the ContinuationOfServicesReason resource to be created or updated.", - "required": true, - "x-bodyName": "ContinuationOfServicesReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -39654,7 +48703,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "continuationOfServicesReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getContinuationOfServicesReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "continuationOfServicesReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putContinuationOfServicesReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor" + } + } + }, + "description": "The JSON representation of the ContinuationOfServicesReason resource to be created or updated.", + "required": true, + "x-bodyName": "ContinuationOfServicesReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -39879,6 +49043,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CostRateDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CostRateDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CostRateDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -39995,7 +49220,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -40038,7 +49263,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -40058,27 +49283,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/costRateDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCostRatesById", + "/ed-fi/costRateDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCostRatesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -40092,48 +49330,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "costRateDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/costRateDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCostRatesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCostRatesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -40141,14 +49368,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CostRateDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -40160,20 +49387,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "costRateDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCostRate", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/costRateDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCostRatesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -40188,18 +49419,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CostRateDescriptor" - } - } - }, - "description": "The JSON representation of the CostRate resource to be created or updated.", - "required": true, - "x-bodyName": "CostRate" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -40217,7 +49436,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "costRateDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCostRatesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "costRateDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCostRate", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor" + } + } + }, + "description": "The JSON representation of the CostRate resource to be created or updated.", + "required": true, + "x-bodyName": "CostRate" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -40442,6 +49776,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CountryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CountryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CountryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -40558,7 +49953,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -40601,7 +49996,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -40621,27 +50016,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/countryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCountriesById", + "/ed-fi/countryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCountriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -40655,48 +50063,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "countryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/countryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCountriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCountriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -40704,14 +50101,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CountryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -40723,20 +50120,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "countryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCountry", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/countryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCountriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -40751,18 +50152,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CountryDescriptor" - } - } - }, - "description": "The JSON representation of the Country resource to be created or updated.", - "required": true, - "x-bodyName": "Country" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -40780,7 +50169,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "countryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCountriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "countryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCountry", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor" + } + } + }, + "description": "The JSON representation of the Country resource to be created or updated.", + "required": true, + "x-bodyName": "Country" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -41005,6 +50509,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseAttemptResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseAttemptResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseAttemptResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -41121,7 +50686,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -41164,7 +50729,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -41184,27 +50749,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseAttemptResultDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseAttemptResultsById", + "/ed-fi/courseAttemptResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseAttemptResultsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -41218,48 +50796,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseAttemptResultDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseAttemptResultDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseAttemptResultsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseAttemptResultsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -41267,14 +50834,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -41286,20 +50853,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseAttemptResultDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseAttemptResult", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseAttemptResultDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseAttemptResultsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -41314,18 +50885,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor" - } - } - }, - "description": "The JSON representation of the CourseAttemptResult resource to be created or updated.", - "required": true, - "x-bodyName": "CourseAttemptResult" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -41343,7 +50902,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseAttemptResultDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseAttemptResultsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseAttemptResultDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseAttemptResult", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor" + } + } + }, + "description": "The JSON representation of the CourseAttemptResult resource to be created or updated.", + "required": true, + "x-bodyName": "CourseAttemptResult" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -41568,6 +51242,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseDefinedByDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseDefinedByDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseDefinedByDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -41684,7 +51419,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -41727,7 +51462,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -41747,27 +51482,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseDefinedByDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseDefinedBiesById", + "/ed-fi/courseDefinedByDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseDefinedBiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -41781,48 +51529,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseDefinedByDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseDefinedByDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseDefinedBiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseDefinedBiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -41830,14 +51567,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -41849,20 +51586,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseDefinedByDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseDefinedBy", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseDefinedByDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseDefinedBiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -41877,18 +51618,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor" - } - } - }, - "description": "The JSON representation of the CourseDefinedBy resource to be created or updated.", - "required": true, - "x-bodyName": "CourseDefinedBy" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -41906,7 +51635,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseDefinedByDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseDefinedBiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseDefinedByDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseDefinedBy", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor" + } + } + }, + "description": "The JSON representation of the CourseDefinedBy resource to be created or updated.", + "required": true, + "x-bodyName": "CourseDefinedBy" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -42131,6 +51975,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -42247,7 +52152,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -42290,7 +52195,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -42310,27 +52215,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseGPAApplicabilityDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseGPAApplicabilitiesById", + "/ed-fi/courseGPAApplicabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseGPAApplicabilitiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -42344,48 +52262,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseGPAApplicabilityDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseGPAApplicabilityDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseGPAApplicabilitiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseGPAApplicabilitiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -42393,14 +52300,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -42412,20 +52319,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseGPAApplicabilityDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseGPAApplicability", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseGPAApplicabilityDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseGPAApplicabilitiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -42440,18 +52351,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor" - } - } - }, - "description": "The JSON representation of the CourseGPAApplicability resource to be created or updated.", - "required": true, - "x-bodyName": "CourseGPAApplicability" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -42469,7 +52368,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseGPAApplicabilityDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseGPAApplicabilitiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseGPAApplicabilityDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseGPAApplicability", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor" + } + } + }, + "description": "The JSON representation of the CourseGPAApplicability resource to be created or updated.", + "required": true, + "x-bodyName": "CourseGPAApplicability" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -42694,6 +52708,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -42810,7 +52885,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -42853,7 +52928,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -42873,27 +52948,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseIdentificationSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseIdentificationSystemsById", + "/ed-fi/courseIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseIdentificationSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -42907,48 +52995,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseIdentificationSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseIdentificationSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseIdentificationSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseIdentificationSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -42956,14 +53033,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -42975,20 +53052,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseIdentificationSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseIdentificationSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseIdentificationSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseIdentificationSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -43003,18 +53084,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor" - } - } - }, - "description": "The JSON representation of the CourseIdentificationSystem resource to be created or updated.", - "required": true, - "x-bodyName": "CourseIdentificationSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -43032,7 +53101,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseIdentificationSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseIdentificationSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseIdentificationSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseIdentificationSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor" + } + } + }, + "description": "The JSON representation of the CourseIdentificationSystem resource to be created or updated.", + "required": true, + "x-bodyName": "CourseIdentificationSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -43257,6 +53441,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -43373,7 +53618,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43416,7 +53661,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -43436,27 +53681,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseLevelCharacteristicDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseLevelCharacteristicsById", + "/ed-fi/courseLevelCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseLevelCharacteristicsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -43470,48 +53728,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseLevelCharacteristicDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseLevelCharacteristicDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseLevelCharacteristicsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseLevelCharacteristicsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -43519,14 +53766,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -43538,20 +53785,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseLevelCharacteristicDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseLevelCharacteristic", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseLevelCharacteristicDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseLevelCharacteristicsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -43566,18 +53817,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor" - } - } - }, - "description": "The JSON representation of the CourseLevelCharacteristic resource to be created or updated.", - "required": true, - "x-bodyName": "CourseLevelCharacteristic" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -43595,7 +53834,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseLevelCharacteristicDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseLevelCharacteristicsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseLevelCharacteristicDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseLevelCharacteristic", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor" + } + } + }, + "description": "The JSON representation of the CourseLevelCharacteristic resource to be created or updated.", + "required": true, + "x-bodyName": "CourseLevelCharacteristic" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44164,6 +54518,79 @@ "sessionName" ], "type": "object" + }, + "EdFi_CourseOffering_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseOffering_TrackedChangeKey": { + "properties": { + "localCourseCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sessionName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName" + ], + "type": "object" + }, + "EdFi_CourseOffering_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -44306,7 +54733,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44349,7 +54776,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44373,27 +54800,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/courseOfferings/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseOfferingsById", + "/ed-fi/courseOfferings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseOfferingsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -44407,48 +54847,41 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseOfferings" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/courseOfferings/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseOfferingsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseOfferingsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -44456,14 +54889,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseOffering" + "items": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -44475,20 +54908,28 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseOfferings" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseOffering", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/courseOfferings/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseOfferingsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -44503,18 +54944,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseOffering" - } - } - }, - "description": "The JSON representation of the CourseOffering resource to be created or updated.", - "required": true, - "x-bodyName": "CourseOffering" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -44532,7 +54961,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseOfferings" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseOfferingsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseOffering" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseOfferings" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseOffering", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseOffering" + } + } + }, + "description": "The JSON representation of the CourseOffering resource to be created or updated.", + "required": true, + "x-bodyName": "CourseOffering" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44780,6 +55324,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseRepeatCodeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseRepeatCodeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -44896,7 +55501,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44939,7 +55544,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44959,27 +55564,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseRepeatCodeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseRepeatCodesById", + "/ed-fi/courseRepeatCodeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseRepeatCodesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -44993,48 +55611,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseRepeatCodeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseRepeatCodeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseRepeatCodesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseRepeatCodesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -45042,14 +55649,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -45061,20 +55668,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseRepeatCodeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseRepeatCode", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseRepeatCodeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseRepeatCodesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -45089,18 +55700,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor" - } - } - }, - "description": "The JSON representation of the CourseRepeatCode resource to be created or updated.", - "required": true, - "x-bodyName": "CourseRepeatCode" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -45118,7 +55717,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseRepeatCodeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseRepeatCodesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseRepeatCodeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseRepeatCode", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor" + } + } + }, + "description": "The JSON representation of the CourseRepeatCode resource to be created or updated.", + "required": true, + "x-bodyName": "CourseRepeatCode" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -46539,6 +57253,94 @@ "sectionReference" ], "type": "object" + }, + "EdFi_CourseTranscript_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseTranscript_TrackedChangeKey": { + "properties": { + "courseAttemptResultDescriptor": { + "maxLength": 306, + "type": "string" + }, + "courseCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "courseEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "courseAttemptResultDescriptor", + "courseCode", + "courseEducationOrganizationId", + "educationOrganizationId", + "schoolYear", + "studentUniqueId", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_CourseTranscript_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -46842,7 +57644,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46885,7 +57687,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -46907,27 +57709,40 @@ "StudentTranscript" ] }, - "/ed-fi/courseTranscripts/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseTranscriptsById", + "/ed-fi/courseTranscripts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseTranscriptsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -46941,48 +57756,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseTranscripts" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "StudentTranscript" + ] + }, + "/ed-fi/courseTranscripts/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseTranscriptsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseTranscriptsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -46990,14 +57796,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseTranscript" + "items": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -47009,20 +57815,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseTranscripts" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseTranscript", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "StudentTranscript" + ] + }, + "/ed-fi/courseTranscripts/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseTranscriptsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -47037,18 +57849,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseTranscript" - } - } - }, - "description": "The JSON representation of the CourseTranscript resource to be created or updated.", - "required": true, - "x-bodyName": "CourseTranscript" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -47066,7 +57866,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseTranscripts" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseTranscriptsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseTranscript" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseTranscripts" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseTranscript", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseTranscript" + } + } + }, + "description": "The JSON representation of the CourseTranscript resource to be created or updated.", + "required": true, + "x-bodyName": "CourseTranscript" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48172,6 +59087,68 @@ "educationOrganizationId" ], "type": "object" + }, + "EdFi_Course_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Course_TrackedChangeKey": { + "properties": { + "courseCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "courseCode", + "educationOrganizationId" + ], + "type": "object" + }, + "EdFi_Course_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -48398,7 +59375,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -48441,7 +59418,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48466,27 +59443,40 @@ "StudentTranscript" ] }, - "/ed-fi/courses/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCoursesById", + "/ed-fi/courses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCoursesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -48500,48 +59490,42 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courses" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "StudentTranscript" + ] + }, + "/ed-fi/courses/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCoursesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCoursesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -48549,14 +59533,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Course" + "items": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -48568,20 +59552,29 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courses" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourse", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "StudentTranscript" + ] + }, + "/ed-fi/courses/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCoursesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -48596,18 +59589,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Course" - } - } - }, - "description": "The JSON representation of the Course resource to be created or updated.", - "required": true, - "x-bodyName": "Course" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -48625,7 +59606,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courses" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCoursesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Course" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courses" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourse", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Course" + } + } + }, + "description": "The JSON representation of the Course resource to be created or updated.", + "required": true, + "x-bodyName": "Course" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48936,6 +60032,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CredentialFieldDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CredentialFieldDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CredentialFieldDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -49052,7 +60209,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49095,7 +60252,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -49115,27 +60272,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/credentialFieldDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCredentialFieldsById", + "/ed-fi/credentialFieldDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialFieldsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -49149,48 +60319,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "credentialFieldDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/credentialFieldDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCredentialFieldsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialFieldsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -49198,14 +60357,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -49217,20 +60376,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "credentialFieldDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCredentialField", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/credentialFieldDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCredentialFieldsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -49245,18 +60408,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor" - } - } - }, - "description": "The JSON representation of the CredentialField resource to be created or updated.", - "required": true, - "x-bodyName": "CredentialField" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -49274,7 +60425,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "credentialFieldDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCredentialFieldsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "credentialFieldDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCredentialField", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor" + } + } + }, + "description": "The JSON representation of the CredentialField resource to be created or updated.", + "required": true, + "x-bodyName": "CredentialField" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -49499,6 +60765,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CredentialTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CredentialTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CredentialTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -49615,7 +60942,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49658,7 +60985,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -49678,27 +61005,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/credentialTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCredentialTypesById", + "/ed-fi/credentialTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -49712,48 +61052,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "credentialTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/credentialTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCredentialTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -49761,14 +61090,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -49780,20 +61109,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "credentialTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCredentialType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/credentialTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCredentialTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -49808,18 +61141,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CredentialType resource to be created or updated.", - "required": true, - "x-bodyName": "CredentialType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -49837,7 +61158,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "credentialTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCredentialTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "credentialTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCredentialType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CredentialType resource to be created or updated.", + "required": true, + "x-bodyName": "CredentialType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -50379,6 +61815,68 @@ "stateOfIssueStateAbbreviationDescriptor" ], "type": "object" + }, + "EdFi_Credential_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Credential_TrackedChangeKey": { + "properties": { + "credentialIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "stateOfIssueStateAbbreviationDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "credentialIdentifier", + "stateOfIssueStateAbbreviationDescriptor" + ], + "type": "object" + }, + "EdFi_Credential_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -50533,7 +62031,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -50576,7 +62074,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -50597,27 +62095,40 @@ "Staff" ] }, - "/ed-fi/credentials/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCredentialsById", + "/ed-fi/credentials/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -50631,48 +62142,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "credentials" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/credentials/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCredentialsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -50680,14 +62181,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Credential" + "items": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -50699,20 +62200,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "credentials" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCredential", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/credentials/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCredentialsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -50727,18 +62233,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Credential" - } - } - }, - "description": "The JSON representation of the Credential resource to be created or updated.", - "required": true, - "x-bodyName": "Credential" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -50756,7 +62250,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "credentials" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCredentialsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Credential" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "credentials" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCredential", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Credential" + } + } + }, + "description": "The JSON representation of the Credential resource to be created or updated.", + "required": true, + "x-bodyName": "Credential" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51011,6 +62620,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CreditCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CreditCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CreditCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -51127,7 +62797,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51170,7 +62840,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51190,27 +62860,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/creditCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCreditCategoriesById", + "/ed-fi/creditCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCreditCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -51224,48 +62907,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "creditCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/creditCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCreditCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCreditCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -51273,14 +62945,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -51292,20 +62964,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "creditCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCreditCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/creditCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCreditCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -51320,18 +62996,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the CreditCategory resource to be created or updated.", - "required": true, - "x-bodyName": "CreditCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -51349,7 +63013,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "creditCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCreditCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "creditCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCreditCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the CreditCategory resource to be created or updated.", + "required": true, + "x-bodyName": "CreditCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51574,6 +63353,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CreditTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CreditTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CreditTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -51690,7 +63530,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51733,7 +63573,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51753,27 +63593,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/creditTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCreditTypesById", + "/ed-fi/creditTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCreditTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -51787,48 +63640,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "creditTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/creditTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCreditTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCreditTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -51836,14 +63678,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -51855,20 +63697,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "creditTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCreditType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/creditTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCreditTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -51883,18 +63729,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CreditType resource to be created or updated.", - "required": true, - "x-bodyName": "CreditType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -51912,7 +63746,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "creditTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCreditTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "creditTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCreditType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CreditType resource to be created or updated.", + "required": true, + "x-bodyName": "CreditType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52137,6 +64086,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CteProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CteProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CteProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -52253,7 +64263,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52296,7 +64306,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52316,27 +64326,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/cteProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCTEProgramServicesById", + "/ed-fi/cteProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCTEProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -52350,48 +64373,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "cteProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cteProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCTEProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCTEProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -52399,14 +64411,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -52418,20 +64430,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "cteProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCTEProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cteProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCTEProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -52446,18 +64462,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the CTEProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "CTEProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -52475,7 +64479,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "cteProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCTEProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "cteProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCTEProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the CTEProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "CTEProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52700,6 +64819,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CurriculumUsedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CurriculumUsedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CurriculumUsedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -52816,7 +64996,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52859,7 +65039,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52879,27 +65059,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/curriculumUsedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCurriculumUsedsById", + "/ed-fi/curriculumUsedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCurriculumUsedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -52913,48 +65106,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "curriculumUsedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/curriculumUsedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCurriculumUsedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCurriculumUsedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -52962,14 +65144,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -52981,20 +65163,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "curriculumUsedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCurriculumUsed", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/curriculumUsedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCurriculumUsedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -53009,18 +65195,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor" - } - } - }, - "description": "The JSON representation of the CurriculumUsed resource to be created or updated.", - "required": true, - "x-bodyName": "CurriculumUsed" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -53038,7 +65212,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "curriculumUsedDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCurriculumUsedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "curriculumUsedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCurriculumUsed", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor" + } + } + }, + "description": "The JSON representation of the CurriculumUsed resource to be created or updated.", + "required": true, + "x-bodyName": "CurriculumUsed" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53263,6 +65552,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DeliveryMethodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DeliveryMethodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DeliveryMethodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -53379,7 +65729,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53422,7 +65772,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53442,27 +65792,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/deliveryMethodDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDeliveryMethodsById", + "/ed-fi/deliveryMethodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDeliveryMethodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -53476,48 +65839,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "deliveryMethodDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/deliveryMethodDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDeliveryMethodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDeliveryMethodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -53525,14 +65877,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -53544,20 +65896,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "deliveryMethodDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDeliveryMethod", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/deliveryMethodDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDeliveryMethodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -53572,18 +65928,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor" - } - } - }, - "description": "The JSON representation of the DeliveryMethod resource to be created or updated.", - "required": true, - "x-bodyName": "DeliveryMethod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -53601,7 +65945,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "deliveryMethodDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDeliveryMethodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "deliveryMethodDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDeliveryMethod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor" + } + } + }, + "description": "The JSON representation of the DeliveryMethod resource to be created or updated.", + "required": true, + "x-bodyName": "DeliveryMethod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53933,6 +66392,81 @@ "value" ], "type": "object" + }, + "EdFi_DescriptorMapping_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DescriptorMapping_TrackedChangeKey": { + "properties": { + "mappedNamespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "mappedValue": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "value": { + "maxLength": 50, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "mappedNamespace", + "mappedValue", + "namespace", + "value" + ], + "type": "object" + }, + "EdFi_DescriptorMapping_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -54037,7 +66571,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54080,7 +66614,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54100,27 +66634,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/descriptorMappings/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDescriptorMappingsById", + "/ed-fi/descriptorMappings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDescriptorMappingsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54134,48 +66681,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "descriptorMappings" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/descriptorMappings/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDescriptorMappingsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDescriptorMappingsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -54183,14 +66719,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DescriptorMapping" + "items": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54202,20 +66738,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "descriptorMappings" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDescriptorMapping", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/descriptorMappings/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDescriptorMappingsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -54230,18 +66770,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DescriptorMapping" - } - } - }, - "description": "The JSON representation of the DescriptorMapping resource to be created or updated.", - "required": true, - "x-bodyName": "DescriptorMapping" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -54259,7 +66787,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "descriptorMappings" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDescriptorMappingsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "descriptorMappings" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDescriptorMapping", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping" + } + } + }, + "description": "The JSON representation of the DescriptorMapping resource to be created or updated.", + "required": true, + "x-bodyName": "DescriptorMapping" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54472,6 +67115,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DiagnosisDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DiagnosisDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DiagnosisDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -54588,7 +67292,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54631,7 +67335,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54651,27 +67355,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/diagnosisDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDiagnosesById", + "/ed-fi/diagnosisDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDiagnosesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54685,48 +67402,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "diagnosisDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diagnosisDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDiagnosesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDiagnosesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -54734,14 +67440,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54753,20 +67459,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "diagnosisDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDiagnosis", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diagnosisDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDiagnosesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -54781,18 +67491,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor" - } - } - }, - "description": "The JSON representation of the Diagnosis resource to be created or updated.", - "required": true, - "x-bodyName": "Diagnosis" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -54810,7 +67508,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "diagnosisDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDiagnosesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "diagnosisDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDiagnosis", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor" + } + } + }, + "description": "The JSON representation of the Diagnosis resource to be created or updated.", + "required": true, + "x-bodyName": "Diagnosis" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55035,6 +67848,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DiplomaLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DiplomaLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DiplomaLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -55151,7 +68025,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55194,7 +68068,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55214,27 +68088,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/diplomaLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDiplomaLevelsById", + "/ed-fi/diplomaLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -55248,48 +68135,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "diplomaLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diplomaLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDiplomaLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -55297,14 +68173,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -55316,20 +68192,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "diplomaLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDiplomaLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diplomaLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDiplomaLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -55344,18 +68224,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor" - } - } - }, - "description": "The JSON representation of the DiplomaLevel resource to be created or updated.", - "required": true, - "x-bodyName": "DiplomaLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -55373,7 +68241,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "diplomaLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDiplomaLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "diplomaLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDiplomaLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor" + } + } + }, + "description": "The JSON representation of the DiplomaLevel resource to be created or updated.", + "required": true, + "x-bodyName": "DiplomaLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55598,6 +68581,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DiplomaTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DiplomaTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DiplomaTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -55714,7 +68758,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55757,7 +68801,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55777,27 +68821,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/diplomaTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDiplomaTypesById", + "/ed-fi/diplomaTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -55811,48 +68868,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "diplomaTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diplomaTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDiplomaTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -55860,14 +68906,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -55879,20 +68925,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "diplomaTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDiplomaType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diplomaTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDiplomaTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -55907,18 +68957,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor" - } - } - }, - "description": "The JSON representation of the DiplomaType resource to be created or updated.", - "required": true, - "x-bodyName": "DiplomaType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -55936,7 +68974,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "diplomaTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDiplomaTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "diplomaTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDiplomaType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor" + } + } + }, + "description": "The JSON representation of the DiplomaType resource to be created or updated.", + "required": true, + "x-bodyName": "DiplomaType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56161,6 +69314,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -56277,7 +69491,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56320,7 +69534,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56340,27 +69554,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disabilityDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisabilitiesById", + "/ed-fi/disabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilitiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -56374,48 +69601,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disabilityDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisabilitiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilitiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -56423,14 +69639,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -56442,20 +69658,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disabilityDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisability", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisabilitiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -56470,18 +69690,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDescriptor" - } - } - }, - "description": "The JSON representation of the Disability resource to be created or updated.", - "required": true, - "x-bodyName": "Disability" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -56499,7 +69707,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disabilityDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisabilitiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disabilityDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisability", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor" + } + } + }, + "description": "The JSON representation of the Disability resource to be created or updated.", + "required": true, + "x-bodyName": "Disability" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56724,6 +70047,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisabilityDesignationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisabilityDesignationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisabilityDesignationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -56840,7 +70224,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56883,7 +70267,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56903,27 +70287,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disabilityDesignationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisabilityDesignationsById", + "/ed-fi/disabilityDesignationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDesignationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -56937,48 +70334,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disabilityDesignationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDesignationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisabilityDesignationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDesignationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -56986,14 +70372,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -57005,20 +70391,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disabilityDesignationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisabilityDesignation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDesignationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisabilityDesignationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -57033,18 +70423,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor" - } - } - }, - "description": "The JSON representation of the DisabilityDesignation resource to be created or updated.", - "required": true, - "x-bodyName": "DisabilityDesignation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -57062,7 +70440,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disabilityDesignationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisabilityDesignationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disabilityDesignationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisabilityDesignation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor" + } + } + }, + "description": "The JSON representation of the DisabilityDesignation resource to be created or updated.", + "required": true, + "x-bodyName": "DisabilityDesignation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -57287,6 +70780,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -57403,7 +70957,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -57446,7 +71000,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -57466,27 +71020,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disabilityDeterminationSourceTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisabilityDeterminationSourceTypesById", + "/ed-fi/disabilityDeterminationSourceTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDeterminationSourceTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -57500,48 +71067,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disabilityDeterminationSourceTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDeterminationSourceTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisabilityDeterminationSourceTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDeterminationSourceTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -57549,14 +71105,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -57568,20 +71124,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disabilityDeterminationSourceTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisabilityDeterminationSourceType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDeterminationSourceTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisabilityDeterminationSourceTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -57596,18 +71156,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor" - } - } - }, - "description": "The JSON representation of the DisabilityDeterminationSourceType resource to be created or updated.", - "required": true, - "x-bodyName": "DisabilityDeterminationSourceType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -57625,7 +71173,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disabilityDeterminationSourceTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisabilityDeterminationSourceTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disabilityDeterminationSourceTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisabilityDeterminationSourceType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor" + } + } + }, + "description": "The JSON representation of the DisabilityDeterminationSourceType resource to be created or updated.", + "required": true, + "x-bodyName": "DisabilityDeterminationSourceType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -57850,6 +71513,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -57966,7 +71690,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -58009,7 +71733,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -58029,27 +71753,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisciplineActionLengthDifferenceReasonsById", + "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionLengthDifferenceReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -58063,48 +71800,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disciplineActionLengthDifferenceReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisciplineActionLengthDifferenceReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionLengthDifferenceReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -58112,14 +71838,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -58131,20 +71857,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disciplineActionLengthDifferenceReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisciplineActionLengthDifferenceReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisciplineActionLengthDifferenceReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -58159,18 +71889,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor" - } - } - }, - "description": "The JSON representation of the DisciplineActionLengthDifferenceReason resource to be created or updated.", - "required": true, - "x-bodyName": "DisciplineActionLengthDifferenceReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -58188,7 +71906,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disciplineActionLengthDifferenceReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisciplineActionLengthDifferenceReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disciplineActionLengthDifferenceReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisciplineActionLengthDifferenceReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor" + } + } + }, + "description": "The JSON representation of the DisciplineActionLengthDifferenceReason resource to be created or updated.", + "required": true, + "x-bodyName": "DisciplineActionLengthDifferenceReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -58840,6 +72673,74 @@ "studentDisciplineIncidentBehaviorAssociationReference" ], "type": "object" + }, + "EdFi_DisciplineAction_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineAction_TrackedChangeKey": { + "properties": { + "disciplineActionIdentifier": { + "maxLength": 36, + "minLength": 1, + "type": "string" + }, + "disciplineDate": { + "format": "date", + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "disciplineActionIdentifier", + "disciplineDate", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_DisciplineAction_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -58995,7 +72896,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59038,7 +72939,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -59059,27 +72960,40 @@ "Discipline" ] }, - "/ed-fi/disciplineActions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisciplineActionsById", + "/ed-fi/disciplineActions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -59093,48 +73007,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disciplineActions" ] }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineActions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisciplineActionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -59142,14 +73046,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineAction" + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -59161,20 +73065,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disciplineActions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisciplineAction", + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineActions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisciplineActionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -59189,18 +73098,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineAction" - } - } - }, - "description": "The JSON representation of the DisciplineAction resource to be created or updated.", - "required": true, - "x-bodyName": "DisciplineAction" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -59218,7 +73115,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disciplineActions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisciplineActionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineAction" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disciplineActions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisciplineAction", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineAction" + } + } + }, + "description": "The JSON representation of the DisciplineAction resource to be created or updated.", + "required": true, + "x-bodyName": "DisciplineAction" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -59478,6 +73490,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisciplineDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisciplineDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -59594,7 +73667,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59637,7 +73710,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -59657,27 +73730,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disciplineDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisciplinesById", + "/ed-fi/disciplineDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplinesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -59691,48 +73777,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disciplineDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisciplinesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplinesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -59740,14 +73815,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -59759,20 +73834,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disciplineDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDiscipline", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisciplinesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -59787,18 +73866,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineDescriptor" - } - } - }, - "description": "The JSON representation of the Discipline resource to be created or updated.", - "required": true, - "x-bodyName": "Discipline" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -59816,7 +73883,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disciplineDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisciplinesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disciplineDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDiscipline", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor" + } + } + }, + "description": "The JSON representation of the Discipline resource to be created or updated.", + "required": true, + "x-bodyName": "Discipline" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -60041,6 +74223,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -60157,7 +74400,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -60200,7 +74443,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -60220,27 +74463,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disciplineIncidentParticipationCodeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisciplineIncidentParticipationCodesById", + "/ed-fi/disciplineIncidentParticipationCodeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentParticipationCodesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -60254,48 +74510,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disciplineIncidentParticipationCodeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineIncidentParticipationCodeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisciplineIncidentParticipationCodesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentParticipationCodesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -60303,14 +74548,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -60322,20 +74567,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disciplineIncidentParticipationCodeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisciplineIncidentParticipationCode", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineIncidentParticipationCodeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisciplineIncidentParticipationCodesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -60350,18 +74599,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor" - } - } - }, - "description": "The JSON representation of the DisciplineIncidentParticipationCode resource to be created or updated.", - "required": true, - "x-bodyName": "DisciplineIncidentParticipationCode" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -60379,7 +74616,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disciplineIncidentParticipationCodeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisciplineIncidentParticipationCodesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disciplineIncidentParticipationCodeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisciplineIncidentParticipationCode", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor" + } + } + }, + "description": "The JSON representation of the DisciplineIncidentParticipationCode resource to be created or updated.", + "required": true, + "x-bodyName": "DisciplineIncidentParticipationCode" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -61004,6 +75356,68 @@ ], "type": "object" }, + "EdFi_DisciplineIncident_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineIncident_TrackedChangeKey": { + "properties": { + "incidentIdentifier": { + "maxLength": 36, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "incidentIdentifier", + "schoolId" + ], + "type": "object" + }, + "EdFi_DisciplineIncident_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_DisciplineIncident_Weapon": { "properties": { "weaponDescriptor": { @@ -61179,7 +75593,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -61222,7 +75636,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -61243,27 +75657,40 @@ "Discipline" ] }, - "/ed-fi/disciplineIncidents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisciplineIncidentsById", + "/ed-fi/disciplineIncidents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -61277,48 +75704,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disciplineIncidents" ] }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineIncidents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisciplineIncidentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -61326,14 +75743,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineIncident" + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -61345,20 +75762,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disciplineIncidents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisciplineIncident", + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineIncidents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisciplineIncidentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -61373,18 +75795,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineIncident" - } - } - }, - "description": "The JSON representation of the DisciplineIncident resource to be created or updated.", - "required": true, - "x-bodyName": "DisciplineIncident" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -61402,7 +75812,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disciplineIncidents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisciplineIncidentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disciplineIncidents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisciplineIncident", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident" + } + } + }, + "description": "The JSON representation of the DisciplineIncident resource to be created or updated.", + "required": true, + "x-bodyName": "DisciplineIncident" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62320,6 +76845,63 @@ "contentIdentifier" ], "type": "object" + }, + "EdFi_EducationContent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationContent_TrackedChangeKey": { + "properties": { + "contentIdentifier": { + "maxLength": 225, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "contentIdentifier" + ], + "type": "object" + }, + "EdFi_EducationContent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -62543,7 +77125,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62586,7 +77168,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62607,27 +77189,40 @@ "Intervention" ] }, - "/ed-fi/educationContents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationContentsById", + "/ed-fi/educationContents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationContentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -62641,48 +77236,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationContents" ] }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/educationContents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationContentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationContentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -62690,14 +77275,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationContent" + "items": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -62709,20 +77294,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationContents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationContent", + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/educationContents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationContentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -62737,18 +77327,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationContent" - } - } - }, - "description": "The JSON representation of the EducationContent resource to be created or updated.", - "required": true, - "x-bodyName": "EducationContent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -62766,7 +77344,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationContents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationContentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationContent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationContents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationContent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationContent" + } + } + }, + "description": "The JSON representation of the EducationContent resource to be created or updated.", + "required": true, + "x-bodyName": "EducationContent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63063,6 +77756,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -63179,7 +77933,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63222,7 +77976,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63242,27 +77996,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationOrganizationAssociationTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationAssociationTypesById", + "/ed-fi/educationOrganizationAssociationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationAssociationTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -63276,48 +78043,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationAssociationTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationAssociationTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationAssociationTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationAssociationTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -63325,14 +78081,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -63344,20 +78100,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationAssociationTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationAssociationType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationAssociationTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationAssociationTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -63372,18 +78132,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor" - } - } - }, - "description": "The JSON representation of the EducationOrganizationAssociationType resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationAssociationType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -63401,7 +78149,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationAssociationTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationAssociationTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationAssociationTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationAssociationType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor" + } + } + }, + "description": "The JSON representation of the EducationOrganizationAssociationType resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationAssociationType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63626,6 +78489,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -63742,7 +78666,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63785,7 +78709,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63805,27 +78729,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationOrganizationCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationCategoriesById", + "/ed-fi/educationOrganizationCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -63839,48 +78776,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -63888,14 +78814,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -63907,20 +78833,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -63935,18 +78865,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the EducationOrganizationCategory resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -63964,7 +78882,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the EducationOrganizationCategory resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -64189,6 +79222,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -64305,7 +79399,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -64348,7 +79442,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -64368,27 +79462,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationOrganizationIdentificationSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationIdentificationSystemsById", + "/ed-fi/educationOrganizationIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationIdentificationSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -64402,48 +79509,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationIdentificationSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationIdentificationSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationIdentificationSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationIdentificationSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -64451,14 +79547,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -64470,20 +79566,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationIdentificationSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationIdentificationSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationIdentificationSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationIdentificationSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -64498,18 +79598,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor" - } - } - }, - "description": "The JSON representation of the EducationOrganizationIdentificationSystem resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationIdentificationSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -64527,7 +79615,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationIdentificationSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationIdentificationSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationIdentificationSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationIdentificationSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor" + } + } + }, + "description": "The JSON representation of the EducationOrganizationIdentificationSystem resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationIdentificationSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -64825,6 +80028,73 @@ "interventionPrescriptionIdentificationCode" ], "type": "object" + }, + "EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionPrescriptionEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionPrescriptionIdentificationCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionPrescriptionEducationOrganizationId", + "interventionPrescriptionIdentificationCode" + ], + "type": "object" + }, + "EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -64934,7 +80204,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -64977,7 +80247,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -64998,27 +80268,40 @@ "Intervention" ] }, - "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationInterventionPrescriptionAssociationsById", + "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -65032,48 +80315,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationInterventionPrescriptionAssociations" ] }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -65081,14 +80354,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -65100,20 +80373,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationInterventionPrescriptionAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationInterventionPrescriptionAssociation", + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationInterventionPrescriptionAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -65128,18 +80406,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation" - } - } - }, - "description": "The JSON representation of the EducationOrganizationInterventionPrescriptionAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationInterventionPrescriptionAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -65157,7 +80423,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationInterventionPrescriptionAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationInterventionPrescriptionAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationInterventionPrescriptionAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation" + } + } + }, + "description": "The JSON representation of the EducationOrganizationInterventionPrescriptionAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationInterventionPrescriptionAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -65436,6 +80817,67 @@ "memberEducationOrganizationId" ], "type": "object" + }, + "EdFi_EducationOrganizationNetworkAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationNetworkId": { + "format": "int64", + "type": "integer" + }, + "memberEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationOrganizationNetworkId", + "memberEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -65534,7 +80976,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -65577,7 +81019,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -65598,27 +81040,40 @@ "EducationOrganization" ] }, - "/ed-fi/educationOrganizationNetworkAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationNetworkAssociationsById", + "/ed-fi/educationOrganizationNetworkAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworkAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -65632,48 +81087,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationNetworkAssociations" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationNetworkAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationNetworkAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworkAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -65681,14 +81126,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -65700,20 +81145,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationNetworkAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationNetworkAssociation", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationNetworkAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationNetworkAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -65728,18 +81178,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation" - } - } - }, - "description": "The JSON representation of the EducationOrganizationNetworkAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationNetworkAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -65757,7 +81195,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationNetworkAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationNetworkAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationNetworkAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationNetworkAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation" + } + } + }, + "description": "The JSON representation of the EducationOrganizationNetworkAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationNetworkAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66780,6 +82333,62 @@ ], "type": "object" }, + "EdFi_EducationOrganizationNetwork_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetwork_TrackedChangeKey": { + "properties": { + "educationOrganizationNetworkId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationOrganizationNetworkId" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetwork_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_EducationOrganization_Address": { "properties": { "addressTypeDescriptor": { @@ -67197,7 +82806,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67240,7 +82849,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67261,27 +82870,40 @@ "EducationOrganization" ] }, - "/ed-fi/educationOrganizationNetworks/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationNetworksById", + "/ed-fi/educationOrganizationNetworks/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworksDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -67295,48 +82917,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationNetworks" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationNetworks/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationNetworksById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworksKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -67344,14 +82956,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -67363,20 +82975,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationNetworks" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationNetwork", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationNetworks/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationNetworksById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -67391,18 +83008,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork" - } - } - }, - "description": "The JSON representation of the EducationOrganizationNetwork resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationNetwork" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -67420,7 +83025,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationNetworks" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationNetworksById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationNetworks" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationNetwork", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork" + } + } + }, + "description": "The JSON representation of the EducationOrganizationNetwork resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationNetwork" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67672,6 +83392,67 @@ "peerEducationOrganizationId" ], "type": "object" + }, + "EdFi_EducationOrganizationPeerAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "peerEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationOrganizationId", + "peerEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_EducationOrganizationPeerAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -67752,7 +83533,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67795,7 +83576,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67815,27 +83596,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationOrganizationPeerAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationPeerAssociationsById", + "/ed-fi/educationOrganizationPeerAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationPeerAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -67849,48 +83643,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationPeerAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationPeerAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationPeerAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationPeerAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -67898,14 +83681,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -67917,20 +83700,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationPeerAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationPeerAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationPeerAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationPeerAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -67945,18 +83732,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation" - } - } - }, - "description": "The JSON representation of the EducationOrganizationPeerAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationPeerAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -67974,7 +83749,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationPeerAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationPeerAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationPeerAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationPeerAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation" + } + } + }, + "description": "The JSON representation of the EducationOrganizationPeerAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationPeerAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68183,6 +84073,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationPlanDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationPlanDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationPlanDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -68299,7 +84250,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68342,7 +84293,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68362,27 +84313,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationPlanDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationPlansById", + "/ed-fi/educationPlanDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationPlansDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -68396,48 +84360,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationPlanDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationPlanDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationPlansById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationPlansKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -68445,14 +84398,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -68464,20 +84417,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationPlanDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationPlan", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationPlanDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationPlansById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -68492,18 +84449,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor" - } - } - }, - "description": "The JSON representation of the EducationPlan resource to be created or updated.", - "required": true, - "x-bodyName": "EducationPlan" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -68521,7 +84466,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationPlanDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationPlansById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationPlanDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationPlan", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor" + } + } + }, + "description": "The JSON representation of the EducationPlan resource to be created or updated.", + "required": true, + "x-bodyName": "EducationPlan" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69859,6 +85919,62 @@ "educationServiceCenterId" ], "type": "object" + }, + "EdFi_EducationServiceCenter_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationServiceCenter_TrackedChangeKey": { + "properties": { + "educationServiceCenterId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationServiceCenterId" + ], + "type": "object" + }, + "EdFi_EducationServiceCenter_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -69978,7 +86094,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70021,7 +86137,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70043,27 +86159,40 @@ "Staff" ] }, - "/ed-fi/educationServiceCenters/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationServiceCentersById", + "/ed-fi/educationServiceCenters/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationServiceCentersDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -70077,48 +86206,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationServiceCenters" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, + "/ed-fi/educationServiceCenters/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationServiceCentersById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationServiceCentersKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -70126,14 +86246,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationServiceCenter" + "items": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -70145,20 +86265,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationServiceCenters" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationServiceCenter", + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, + "/ed-fi/educationServiceCenters/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationServiceCentersById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -70173,18 +86299,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationServiceCenter" - } - } - }, - "description": "The JSON representation of the EducationServiceCenter resource to be created or updated.", - "required": true, - "x-bodyName": "EducationServiceCenter" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -70202,7 +86316,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationServiceCenters" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationServiceCentersById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationServiceCenters" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationServiceCenter", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter" + } + } + }, + "description": "The JSON representation of the EducationServiceCenter resource to be created or updated.", + "required": true, + "x-bodyName": "EducationServiceCenter" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70443,6 +86672,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationalEnvironmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationalEnvironmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -70559,7 +86849,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70602,7 +86892,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70622,27 +86912,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationalEnvironmentDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationalEnvironmentsById", + "/ed-fi/educationalEnvironmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationalEnvironmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -70656,48 +86959,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationalEnvironmentDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationalEnvironmentDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationalEnvironmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationalEnvironmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -70705,14 +86997,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -70724,20 +87016,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationalEnvironmentDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationalEnvironment", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationalEnvironmentDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationalEnvironmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -70752,18 +87048,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor" - } - } - }, - "description": "The JSON representation of the EducationalEnvironment resource to be created or updated.", - "required": true, - "x-bodyName": "EducationalEnvironment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -70781,7 +87065,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationalEnvironmentDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationalEnvironmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationalEnvironmentDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationalEnvironment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor" + } + } + }, + "description": "The JSON representation of the EducationalEnvironment resource to be created or updated.", + "required": true, + "x-bodyName": "EducationalEnvironment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -71006,6 +87405,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ElectronicMailTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ElectronicMailTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -71122,7 +87582,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71165,7 +87625,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -71185,27 +87645,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/electronicMailTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteElectronicMailTypesById", + "/ed-fi/electronicMailTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getElectronicMailTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -71219,48 +87692,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "electronicMailTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/electronicMailTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getElectronicMailTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getElectronicMailTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -71268,14 +87730,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -71287,20 +87749,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "electronicMailTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putElectronicMailType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/electronicMailTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteElectronicMailTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -71315,18 +87781,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ElectronicMailType resource to be created or updated.", - "required": true, - "x-bodyName": "ElectronicMailType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -71344,7 +87798,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "electronicMailTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getElectronicMailTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "electronicMailTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putElectronicMailType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ElectronicMailType resource to be created or updated.", + "required": true, + "x-bodyName": "ElectronicMailType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -71569,6 +88138,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EligibilityDelayReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -71685,7 +88315,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71728,7 +88358,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -71748,27 +88378,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/eligibilityDelayReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEligibilityDelayReasonsById", + "/ed-fi/eligibilityDelayReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityDelayReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -71782,48 +88425,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "eligibilityDelayReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eligibilityDelayReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEligibilityDelayReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityDelayReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -71831,14 +88463,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -71850,20 +88482,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "eligibilityDelayReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEligibilityDelayReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eligibilityDelayReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEligibilityDelayReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -71878,18 +88514,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor" - } - } - }, - "description": "The JSON representation of the EligibilityDelayReason resource to be created or updated.", - "required": true, - "x-bodyName": "EligibilityDelayReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -71907,7 +88531,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "eligibilityDelayReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEligibilityDelayReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "eligibilityDelayReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEligibilityDelayReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor" + } + } + }, + "description": "The JSON representation of the EligibilityDelayReason resource to be created or updated.", + "required": true, + "x-bodyName": "EligibilityDelayReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72132,6 +88871,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -72248,7 +89048,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72291,7 +89091,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72311,27 +89111,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/eligibilityEvaluationTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEligibilityEvaluationTypesById", + "/ed-fi/eligibilityEvaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityEvaluationTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -72345,48 +89158,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "eligibilityEvaluationTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eligibilityEvaluationTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEligibilityEvaluationTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityEvaluationTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -72394,14 +89196,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -72413,20 +89215,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "eligibilityEvaluationTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEligibilityEvaluationType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eligibilityEvaluationTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEligibilityEvaluationTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -72441,18 +89247,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor" - } - } - }, - "description": "The JSON representation of the EligibilityEvaluationType resource to be created or updated.", - "required": true, - "x-bodyName": "EligibilityEvaluationType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -72470,7 +89264,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "eligibilityEvaluationTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEligibilityEvaluationTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "eligibilityEvaluationTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEligibilityEvaluationType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor" + } + } + }, + "description": "The JSON representation of the EligibilityEvaluationType resource to be created or updated.", + "required": true, + "x-bodyName": "EligibilityEvaluationType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72695,6 +89604,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EmploymentStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EmploymentStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EmploymentStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -72811,7 +89781,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72854,7 +89824,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72874,27 +89844,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/employmentStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEmploymentStatusesById", + "/ed-fi/employmentStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEmploymentStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -72908,48 +89891,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "employmentStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/employmentStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEmploymentStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEmploymentStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -72957,14 +89929,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -72976,20 +89948,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "employmentStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEmploymentStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/employmentStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEmploymentStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -73004,18 +89980,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor" - } - } - }, - "description": "The JSON representation of the EmploymentStatus resource to be created or updated.", - "required": true, - "x-bodyName": "EmploymentStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -73033,7 +89997,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "employmentStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEmploymentStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "employmentStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEmploymentStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor" + } + } + }, + "description": "The JSON representation of the EmploymentStatus resource to be created or updated.", + "required": true, + "x-bodyName": "EmploymentStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -73258,6 +90337,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EnrollmentTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EnrollmentTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EnrollmentTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -73374,7 +90514,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73417,7 +90557,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -73437,27 +90577,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/enrollmentTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEnrollmentTypesById", + "/ed-fi/enrollmentTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEnrollmentTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -73471,48 +90624,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "enrollmentTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/enrollmentTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEnrollmentTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEnrollmentTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -73520,14 +90662,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -73539,20 +90681,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "enrollmentTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEnrollmentType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/enrollmentTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEnrollmentTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -73567,18 +90713,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor" - } - } - }, - "description": "The JSON representation of the EnrollmentType resource to be created or updated.", - "required": true, - "x-bodyName": "EnrollmentType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -73596,7 +90730,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "enrollmentTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEnrollmentTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "enrollmentTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEnrollmentType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor" + } + } + }, + "description": "The JSON representation of the EnrollmentType resource to be created or updated.", + "required": true, + "x-bodyName": "EnrollmentType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -73821,6 +91070,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -73937,7 +91247,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73980,7 +91290,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -74000,27 +91310,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/entryGradeLevelReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEntryGradeLevelReasonsById", + "/ed-fi/entryGradeLevelReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEntryGradeLevelReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -74034,48 +91357,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "entryGradeLevelReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/entryGradeLevelReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEntryGradeLevelReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEntryGradeLevelReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -74083,14 +91395,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -74102,20 +91414,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "entryGradeLevelReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEntryGradeLevelReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/entryGradeLevelReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEntryGradeLevelReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -74130,18 +91446,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor" - } - } - }, - "description": "The JSON representation of the EntryGradeLevelReason resource to be created or updated.", - "required": true, - "x-bodyName": "EntryGradeLevelReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -74159,7 +91463,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "entryGradeLevelReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEntryGradeLevelReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "entryGradeLevelReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEntryGradeLevelReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor" + } + } + }, + "description": "The JSON representation of the EntryGradeLevelReason resource to be created or updated.", + "required": true, + "x-bodyName": "EntryGradeLevelReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -74384,6 +91803,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EntryTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EntryTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EntryTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -74500,7 +91980,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -74543,7 +92023,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -74563,27 +92043,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/entryTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEntryTypesById", + "/ed-fi/entryTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEntryTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -74597,48 +92090,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "entryTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/entryTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEntryTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEntryTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -74646,14 +92128,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -74665,20 +92147,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "entryTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEntryType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/entryTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEntryTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -74693,18 +92179,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor" - } - } - }, - "description": "The JSON representation of the EntryType resource to be created or updated.", - "required": true, - "x-bodyName": "EntryType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -74722,7 +92196,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "entryTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEntryTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "entryTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEntryType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor" + } + } + }, + "description": "The JSON representation of the EntryType resource to be created or updated.", + "required": true, + "x-bodyName": "EntryType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -74947,6 +92536,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EvaluationDelayReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -75063,7 +92713,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -75106,7 +92756,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -75126,27 +92776,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/evaluationDelayReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEvaluationDelayReasonsById", + "/ed-fi/evaluationDelayReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationDelayReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -75160,48 +92823,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationDelayReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/evaluationDelayReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEvaluationDelayReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationDelayReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -75209,14 +92861,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -75228,20 +92880,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationDelayReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEvaluationDelayReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/evaluationDelayReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEvaluationDelayReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -75256,18 +92912,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor" - } - } - }, - "description": "The JSON representation of the EvaluationDelayReason resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationDelayReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -75285,7 +92929,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "evaluationDelayReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEvaluationDelayReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "evaluationDelayReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEvaluationDelayReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor" + } + } + }, + "description": "The JSON representation of the EvaluationDelayReason resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationDelayReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -75689,6 +93448,98 @@ "programEvaluationElementTitle" ], "type": "object" + }, + "EdFi_EvaluationRubricDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationRubricDimension_TrackedChangeKey": { + "properties": { + "evaluationRubricRating": { + "format": "int32", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationElementTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "evaluationRubricRating", + "programEducationOrganizationId", + "programEvaluationElementTitle", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_EvaluationRubricDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -75858,7 +93709,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -75901,7 +93752,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -75922,27 +93773,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/evaluationRubricDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEvaluationRubricDimensionsById", + "/ed-fi/evaluationRubricDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRubricDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -75956,48 +93820,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationRubricDimensions" ] }, + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/evaluationRubricDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEvaluationRubricDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRubricDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -76005,14 +93859,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension" + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -76024,20 +93878,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationRubricDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEvaluationRubricDimension", + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/evaluationRubricDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEvaluationRubricDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -76052,18 +93911,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension" - } - } - }, - "description": "The JSON representation of the EvaluationRubricDimension resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationRubricDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -76081,7 +93928,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "evaluationRubricDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEvaluationRubricDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "evaluationRubricDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEvaluationRubricDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension" + } + } + }, + "description": "The JSON representation of the EvaluationRubricDimension resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationRubricDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76340,6 +94302,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EventCircumstanceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EventCircumstanceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EventCircumstanceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -76456,7 +94479,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -76499,7 +94522,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76519,27 +94542,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/eventCircumstanceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEventCircumstancesById", + "/ed-fi/eventCircumstanceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEventCircumstancesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -76553,48 +94589,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "eventCircumstanceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eventCircumstanceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEventCircumstancesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEventCircumstancesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -76602,14 +94627,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -76621,20 +94646,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "eventCircumstanceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEventCircumstance", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eventCircumstanceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEventCircumstancesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -76649,18 +94678,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor" - } - } - }, - "description": "The JSON representation of the EventCircumstance resource to be created or updated.", - "required": true, - "x-bodyName": "EventCircumstance" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -76678,7 +94695,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "eventCircumstanceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEventCircumstancesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "eventCircumstanceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEventCircumstance", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor" + } + } + }, + "description": "The JSON representation of the EventCircumstance resource to be created or updated.", + "required": true, + "x-bodyName": "EventCircumstance" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76903,6 +95035,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ExitWithdrawTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -77019,7 +95212,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77062,7 +95255,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77082,27 +95275,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/exitWithdrawTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteExitWithdrawTypesById", + "/ed-fi/exitWithdrawTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getExitWithdrawTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -77116,48 +95322,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "exitWithdrawTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/exitWithdrawTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getExitWithdrawTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getExitWithdrawTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -77165,14 +95360,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -77184,20 +95379,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "exitWithdrawTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putExitWithdrawType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/exitWithdrawTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteExitWithdrawTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -77212,18 +95411,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ExitWithdrawType resource to be created or updated.", - "required": true, - "x-bodyName": "ExitWithdrawType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -77241,7 +95428,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "exitWithdrawTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getExitWithdrawTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "exitWithdrawTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putExitWithdrawType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ExitWithdrawType resource to be created or updated.", + "required": true, + "x-bodyName": "ExitWithdrawType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77547,6 +95849,72 @@ "schoolId" ], "type": "object" + }, + "EdFi_FeederSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FeederSchoolAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "feederSchoolId": { + "format": "int64", + "type": "integer" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "beginDate", + "feederSchoolId", + "schoolId" + ], + "type": "object" + }, + "EdFi_FeederSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -77656,7 +96024,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77699,7 +96067,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77720,27 +96088,40 @@ "EducationOrganization" ] }, - "/ed-fi/feederSchoolAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteFeederSchoolAssociationsById", + "/ed-fi/feederSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFeederSchoolAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -77754,48 +96135,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "feederSchoolAssociations" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/feederSchoolAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getFeederSchoolAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFeederSchoolAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -77803,14 +96174,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -77822,20 +96193,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "feederSchoolAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putFeederSchoolAssociation", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/feederSchoolAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteFeederSchoolAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -77850,18 +96226,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation" - } - } - }, - "description": "The JSON representation of the FeederSchoolAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "FeederSchoolAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -77879,7 +96243,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "feederSchoolAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getFeederSchoolAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "feederSchoolAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putFeederSchoolAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation" + } + } + }, + "description": "The JSON representation of the FeederSchoolAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "FeederSchoolAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78107,6 +96586,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_FinancialCollectionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FinancialCollectionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_FinancialCollectionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -78223,7 +96763,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78266,7 +96806,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78286,27 +96826,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/financialCollectionDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteFinancialCollectionsById", + "/ed-fi/financialCollectionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFinancialCollectionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -78320,48 +96873,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "financialCollectionDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/financialCollectionDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getFinancialCollectionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFinancialCollectionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -78369,14 +96911,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -78388,20 +96930,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "financialCollectionDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putFinancialCollection", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/financialCollectionDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteFinancialCollectionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -78416,18 +96962,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor" - } - } - }, - "description": "The JSON representation of the FinancialCollection resource to be created or updated.", - "required": true, - "x-bodyName": "FinancialCollection" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -78445,7 +96979,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "financialCollectionDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getFinancialCollectionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "financialCollectionDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putFinancialCollection", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor" + } + } + }, + "description": "The JSON representation of the FinancialCollection resource to be created or updated.", + "required": true, + "x-bodyName": "FinancialCollection" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78737,6 +97386,68 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_FunctionDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FunctionDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "minLength": 1, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_FunctionDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -78828,7 +97539,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78871,7 +97582,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78892,27 +97603,40 @@ "Finance" ] }, - "/ed-fi/functionDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteFunctionDimensionsById", + "/ed-fi/functionDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFunctionDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -78926,48 +97650,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "functionDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/functionDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getFunctionDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFunctionDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -78975,14 +97689,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_FunctionDimension" + "items": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -78994,20 +97708,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "functionDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putFunctionDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/functionDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteFunctionDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -79022,18 +97741,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_FunctionDimension" - } - } - }, - "description": "The JSON representation of the FunctionDimension resource to be created or updated.", - "required": true, - "x-bodyName": "FunctionDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -79051,7 +97758,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "functionDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getFunctionDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FunctionDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "functionDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putFunctionDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FunctionDimension" + } + } + }, + "description": "The JSON representation of the FunctionDimension resource to be created or updated.", + "required": true, + "x-bodyName": "FunctionDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79325,6 +98147,68 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_FundDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FundDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "minLength": 1, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_FundDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -79416,7 +98300,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79459,7 +98343,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79480,27 +98364,40 @@ "Finance" ] }, - "/ed-fi/fundDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteFundDimensionsById", + "/ed-fi/fundDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFundDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -79514,48 +98411,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "fundDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/fundDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getFundDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFundDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -79563,14 +98450,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_FundDimension" + "items": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -79582,20 +98469,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "fundDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putFundDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/fundDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteFundDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -79610,18 +98502,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_FundDimension" - } - } - }, - "description": "The JSON representation of the FundDimension resource to be created or updated.", - "required": true, - "x-bodyName": "FundDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -79639,7 +98519,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "fundDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getFundDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FundDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "fundDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putFundDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FundDimension" + } + } + }, + "description": "The JSON representation of the FundDimension resource to be created or updated.", + "required": true, + "x-bodyName": "FundDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79846,6 +98841,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradeLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradeLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradeLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -79962,7 +99018,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80005,7 +99061,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -80025,27 +99081,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gradeLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradeLevelsById", + "/ed-fi/gradeLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradeLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -80059,48 +99128,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradeLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradeLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradeLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradeLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -80108,14 +99166,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -80127,20 +99185,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradeLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradeLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradeLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradeLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -80155,18 +99217,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor" - } - } - }, - "description": "The JSON representation of the GradeLevel resource to be created or updated.", - "required": true, - "x-bodyName": "GradeLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -80184,7 +99234,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradeLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradeLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradeLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradeLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor" + } + } + }, + "description": "The JSON representation of the GradeLevel resource to be created or updated.", + "required": true, + "x-bodyName": "GradeLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -80409,6 +99574,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradePointAverageTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradePointAverageTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -80525,7 +99751,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80568,7 +99794,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -80588,27 +99814,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gradePointAverageTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradePointAverageTypesById", + "/ed-fi/gradePointAverageTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradePointAverageTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -80622,48 +99861,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradePointAverageTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradePointAverageTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradePointAverageTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradePointAverageTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -80671,14 +99899,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -80690,20 +99918,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradePointAverageTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradePointAverageType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradePointAverageTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradePointAverageTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -80718,18 +99950,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor" - } - } - }, - "description": "The JSON representation of the GradePointAverageType resource to be created or updated.", - "required": true, - "x-bodyName": "GradePointAverageType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -80747,7 +99967,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradePointAverageTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradePointAverageTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradePointAverageTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradePointAverageType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor" + } + } + }, + "description": "The JSON representation of the GradePointAverageType resource to be created or updated.", + "required": true, + "x-bodyName": "GradePointAverageType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -80972,6 +100307,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradeTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradeTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradeTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -81088,7 +100484,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81131,7 +100527,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81151,27 +100547,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gradeTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradeTypesById", + "/ed-fi/gradeTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradeTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -81185,48 +100594,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradeTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradeTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradeTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradeTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -81234,14 +100632,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -81253,20 +100651,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradeTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradeType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradeTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradeTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -81281,18 +100683,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor" - } - } - }, - "description": "The JSON representation of the GradeType resource to be created or updated.", - "required": true, - "x-bodyName": "GradeType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -81310,7 +100700,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradeTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradeTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradeTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradeType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor" + } + } + }, + "description": "The JSON representation of the GradeType resource to be created or updated.", + "required": true, + "x-bodyName": "GradeType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81917,6 +101422,69 @@ "namespace" ], "type": "object" + }, + "EdFi_GradebookEntry_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradebookEntry_TrackedChangeKey": { + "properties": { + "gradebookEntryIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "gradebookEntryIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_GradebookEntry_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -82146,7 +101714,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82189,7 +101757,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82211,27 +101779,40 @@ "Gradebook" ] }, - "/ed-fi/gradebookEntries/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradebookEntriesById", + "/ed-fi/gradebookEntries/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -82245,48 +101826,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradebookEntries" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/gradebookEntries/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradebookEntriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -82294,14 +101866,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradebookEntry" + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -82313,20 +101885,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradebookEntries" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradebookEntry", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/gradebookEntries/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradebookEntriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -82341,18 +101919,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradebookEntry" - } - } - }, - "description": "The JSON representation of the GradebookEntry resource to be created or updated.", - "required": true, - "x-bodyName": "GradebookEntry" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -82370,7 +101936,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradebookEntries" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradebookEntriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradebookEntry" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradebookEntries" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradebookEntry", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradebookEntry" + } + } + }, + "description": "The JSON representation of the GradebookEntry resource to be created or updated.", + "required": true, + "x-bodyName": "GradebookEntry" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82664,6 +102345,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradebookEntryTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradebookEntryTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -82780,7 +102522,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82823,7 +102565,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82843,27 +102585,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gradebookEntryTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradebookEntryTypesById", + "/ed-fi/gradebookEntryTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntryTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -82877,48 +102632,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradebookEntryTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradebookEntryTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradebookEntryTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntryTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -82926,14 +102670,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -82945,20 +102689,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradebookEntryTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradebookEntryType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradebookEntryTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradebookEntryTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -82973,18 +102721,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor" - } - } - }, - "description": "The JSON representation of the GradebookEntryType resource to be created or updated.", - "required": true, - "x-bodyName": "GradebookEntryType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -83002,7 +102738,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradebookEntryTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradebookEntryTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradebookEntryTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradebookEntryType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor" + } + } + }, + "description": "The JSON representation of the GradebookEntryType resource to be created or updated.", + "required": true, + "x-bodyName": "GradebookEntryType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83761,6 +103612,117 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_Grade_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Grade_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "gradeTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "gradingPeriodSchoolYear": { + "format": "int32", + "type": "integer" + }, + "localCourseCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "gradeTypeDescriptor", + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolYear", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_Grade_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -84001,7 +103963,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84044,7 +104006,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84066,27 +104028,40 @@ "ReportCard" ] }, - "/ed-fi/grades/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradesById", + "/ed-fi/grades/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -84100,48 +104075,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "grades" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/grades/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -84149,14 +104115,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Grade" + "items": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -84168,20 +104134,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "grades" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGrade", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/grades/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -84196,18 +104168,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Grade" - } - } - }, - "description": "The JSON representation of the Grade resource to be created or updated.", - "required": true, - "x-bodyName": "Grade" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -84225,7 +104185,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "grades" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Grade" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "grades" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGrade", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Grade" + } + } + }, + "description": "The JSON representation of the Grade resource to be created or updated.", + "required": true, + "x-bodyName": "Grade" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84534,6 +104609,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradingPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradingPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradingPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -84650,7 +104786,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84693,7 +104829,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84713,27 +104849,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gradingPeriodDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradingPeriodsById", + "/ed-fi/gradingPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -84747,48 +104896,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradingPeriodDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradingPeriodDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradingPeriodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -84796,14 +104934,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -84815,20 +104953,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradingPeriodDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradingPeriod", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradingPeriodDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradingPeriodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -84843,18 +104985,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor" - } - } - }, - "description": "The JSON representation of the GradingPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "GradingPeriod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -84872,7 +105002,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradingPeriodDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradingPeriodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradingPeriodDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradingPeriod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor" + } + } + }, + "description": "The JSON representation of the GradingPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "GradingPeriod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85259,6 +105504,78 @@ "schoolYear" ], "type": "object" + }, + "EdFi_GradingPeriod_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradingPeriod_TrackedChangeKey": { + "properties": { + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "gradingPeriodDescriptor", + "gradingPeriodName", + "schoolId", + "schoolYear" + ], + "type": "object" + }, + "EdFi_GradingPeriod_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -85396,7 +105713,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85439,7 +105756,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85462,27 +105779,40 @@ "ReportCard" ] }, - "/ed-fi/gradingPeriods/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradingPeriodsById", + "/ed-fi/gradingPeriods/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -85496,48 +105826,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradingPeriods" ] }, + "x-Ed-Fi-domains": [ + "SchoolCalendar", + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/gradingPeriods/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradingPeriodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -85545,14 +105867,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradingPeriod" + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -85564,20 +105886,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradingPeriods" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradingPeriod", + "x-Ed-Fi-domains": [ + "SchoolCalendar", + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/gradingPeriods/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradingPeriodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -85592,18 +105921,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradingPeriod" - } - } - }, - "description": "The JSON representation of the GradingPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "GradingPeriod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -85621,7 +105938,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradingPeriods" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradingPeriodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradingPeriod" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradingPeriods" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradingPeriod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradingPeriod" + } + } + }, + "description": "The JSON representation of the GradingPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "GradingPeriod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85864,6 +106296,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GraduationPlanTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GraduationPlanTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -85980,7 +106473,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86023,7 +106516,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86043,27 +106536,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/graduationPlanTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGraduationPlanTypesById", + "/ed-fi/graduationPlanTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlanTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -86077,48 +106583,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "graduationPlanTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/graduationPlanTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGraduationPlanTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlanTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -86126,14 +106621,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -86145,20 +106640,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "graduationPlanTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGraduationPlanType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/graduationPlanTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGraduationPlanTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -86173,18 +106672,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor" - } - } - }, - "description": "The JSON representation of the GraduationPlanType resource to be created or updated.", - "required": true, - "x-bodyName": "GraduationPlanType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -86202,7 +106689,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "graduationPlanTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGraduationPlanTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "graduationPlanTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGraduationPlanType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor" + } + } + }, + "description": "The JSON representation of the GraduationPlanType resource to be created or updated.", + "required": true, + "x-bodyName": "GraduationPlanType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87373,6 +107975,72 @@ "assessmentReportingMethodDescriptor" ], "type": "object" + }, + "EdFi_GraduationPlan_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GraduationPlan_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "graduationPlanTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "graduationSchoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "educationOrganizationId", + "graduationPlanTypeDescriptor", + "graduationSchoolYear" + ], + "type": "object" + }, + "EdFi_GraduationPlan_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -87498,7 +108166,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87541,7 +108209,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87563,27 +108231,40 @@ "Graduation" ] }, - "/ed-fi/graduationPlans/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGraduationPlansById", + "/ed-fi/graduationPlans/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlansDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -87597,48 +108278,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "graduationPlans" ] }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation" + ] + }, + "/ed-fi/graduationPlans/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGraduationPlansById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlansKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -87646,14 +108318,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GraduationPlan" + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -87665,20 +108337,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "graduationPlans" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGraduationPlan", + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation" + ] + }, + "/ed-fi/graduationPlans/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGraduationPlansById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -87693,18 +108371,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GraduationPlan" - } - } - }, - "description": "The JSON representation of the GraduationPlan resource to be created or updated.", - "required": true, - "x-bodyName": "GraduationPlan" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -87722,7 +108388,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "graduationPlans" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGraduationPlansById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GraduationPlan" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "graduationPlans" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGraduationPlan", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GraduationPlan" + } + } + }, + "description": "The JSON representation of the GraduationPlan resource to be created or updated.", + "required": true, + "x-bodyName": "GraduationPlan" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87970,6 +108751,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -88086,7 +108928,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88129,7 +108971,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -88149,27 +108991,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGunFreeSchoolsActReportingStatusesById", + "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGunFreeSchoolsActReportingStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -88183,48 +109038,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gunFreeSchoolsActReportingStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGunFreeSchoolsActReportingStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGunFreeSchoolsActReportingStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -88232,14 +109076,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -88251,20 +109095,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gunFreeSchoolsActReportingStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGunFreeSchoolsActReportingStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGunFreeSchoolsActReportingStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -88279,18 +109127,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor" - } - } - }, - "description": "The JSON representation of the GunFreeSchoolsActReportingStatus resource to be created or updated.", - "required": true, - "x-bodyName": "GunFreeSchoolsActReportingStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -88308,7 +109144,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gunFreeSchoolsActReportingStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGunFreeSchoolsActReportingStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gunFreeSchoolsActReportingStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGunFreeSchoolsActReportingStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor" + } + } + }, + "description": "The JSON representation of the GunFreeSchoolsActReportingStatus resource to be created or updated.", + "required": true, + "x-bodyName": "GunFreeSchoolsActReportingStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -88533,6 +109484,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -88649,7 +109661,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88692,7 +109704,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -88712,27 +109724,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteHomelessPrimaryNighttimeResidencesById", + "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessPrimaryNighttimeResidencesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -88746,48 +109771,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "homelessPrimaryNighttimeResidenceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getHomelessPrimaryNighttimeResidencesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessPrimaryNighttimeResidencesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -88795,14 +109809,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -88814,20 +109828,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "homelessPrimaryNighttimeResidenceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putHomelessPrimaryNighttimeResidence", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteHomelessPrimaryNighttimeResidencesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -88842,18 +109860,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor" - } - } - }, - "description": "The JSON representation of the HomelessPrimaryNighttimeResidence resource to be created or updated.", - "required": true, - "x-bodyName": "HomelessPrimaryNighttimeResidence" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -88871,7 +109877,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "homelessPrimaryNighttimeResidenceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getHomelessPrimaryNighttimeResidencesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "homelessPrimaryNighttimeResidenceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putHomelessPrimaryNighttimeResidence", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor" + } + } + }, + "description": "The JSON representation of the HomelessPrimaryNighttimeResidence resource to be created or updated.", + "required": true, + "x-bodyName": "HomelessPrimaryNighttimeResidence" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89096,6 +110217,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_HomelessProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_HomelessProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -89212,7 +110394,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89255,7 +110437,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89275,27 +110457,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/homelessProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteHomelessProgramServicesById", + "/ed-fi/homelessProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -89309,48 +110504,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "homelessProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/homelessProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getHomelessProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -89358,14 +110542,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -89377,20 +110561,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "homelessProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putHomelessProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/homelessProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteHomelessProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -89405,18 +110593,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the HomelessProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "HomelessProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -89434,7 +110610,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "homelessProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getHomelessProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "homelessProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putHomelessProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the HomelessProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "HomelessProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89659,6 +110950,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IdeaPartDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IdeaPartDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IdeaPartDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -89775,7 +111127,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89818,7 +111170,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89838,27 +111190,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/ideaPartDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIDEAPartsById", + "/ed-fi/ideaPartDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIDEAPartsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -89872,48 +111237,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "ideaPartDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ideaPartDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIDEAPartsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIDEAPartsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -89921,14 +111275,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -89940,20 +111294,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "ideaPartDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIDEAPart", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ideaPartDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIDEAPartsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -89968,18 +111326,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor" - } - } - }, - "description": "The JSON representation of the IDEAPart resource to be created or updated.", - "required": true, - "x-bodyName": "IDEAPart" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -89997,7 +111343,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "ideaPartDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIDEAPartsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "ideaPartDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIDEAPart", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor" + } + } + }, + "description": "The JSON representation of the IDEAPart resource to be created or updated.", + "required": true, + "x-bodyName": "IDEAPart" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90222,6 +111683,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IdentificationDocumentUseDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -90338,7 +111860,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90381,7 +111903,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90401,27 +111923,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/identificationDocumentUseDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIdentificationDocumentUsesById", + "/ed-fi/identificationDocumentUseDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIdentificationDocumentUsesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -90435,48 +111970,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "identificationDocumentUseDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/identificationDocumentUseDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIdentificationDocumentUsesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIdentificationDocumentUsesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -90484,14 +112008,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -90503,20 +112027,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "identificationDocumentUseDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIdentificationDocumentUse", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/identificationDocumentUseDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIdentificationDocumentUsesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -90531,18 +112059,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor" - } - } - }, - "description": "The JSON representation of the IdentificationDocumentUse resource to be created or updated.", - "required": true, - "x-bodyName": "IdentificationDocumentUse" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -90560,7 +112076,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "identificationDocumentUseDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIdentificationDocumentUsesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "identificationDocumentUseDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIdentificationDocumentUse", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor" + } + } + }, + "description": "The JSON representation of the IdentificationDocumentUse resource to be created or updated.", + "required": true, + "x-bodyName": "IdentificationDocumentUse" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90785,6 +112416,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IncidentLocationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IncidentLocationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IncidentLocationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -90901,7 +112593,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90944,7 +112636,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90964,27 +112656,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/incidentLocationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIncidentLocationsById", + "/ed-fi/incidentLocationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIncidentLocationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -90998,48 +112703,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "incidentLocationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/incidentLocationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIncidentLocationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIncidentLocationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -91047,14 +112741,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -91066,20 +112760,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "incidentLocationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIncidentLocation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/incidentLocationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIncidentLocationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -91094,18 +112792,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor" - } - } - }, - "description": "The JSON representation of the IncidentLocation resource to be created or updated.", - "required": true, - "x-bodyName": "IncidentLocation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -91123,7 +112809,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "incidentLocationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIncidentLocationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "incidentLocationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIncidentLocation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor" + } + } + }, + "description": "The JSON representation of the IncidentLocation resource to be created or updated.", + "required": true, + "x-bodyName": "IncidentLocation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -91348,6 +113149,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IndicatorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IndicatorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IndicatorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -91464,7 +113326,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91507,7 +113369,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -91527,27 +113389,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/indicatorDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIndicatorsById", + "/ed-fi/indicatorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -91561,48 +113436,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "indicatorDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIndicatorsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -91610,14 +113474,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -91629,20 +113493,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "indicatorDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIndicator", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIndicatorsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -91657,18 +113525,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorDescriptor" - } - } - }, - "description": "The JSON representation of the Indicator resource to be created or updated.", - "required": true, - "x-bodyName": "Indicator" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -91686,7 +113542,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "indicatorDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIndicatorsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "indicatorDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIndicator", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor" + } + } + }, + "description": "The JSON representation of the Indicator resource to be created or updated.", + "required": true, + "x-bodyName": "Indicator" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -91911,6 +113882,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IndicatorGroupDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IndicatorGroupDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IndicatorGroupDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -92027,7 +114059,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92070,7 +114102,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92090,27 +114122,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/indicatorGroupDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIndicatorGroupsById", + "/ed-fi/indicatorGroupDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorGroupsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -92124,48 +114169,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "indicatorGroupDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorGroupDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIndicatorGroupsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorGroupsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -92173,14 +114207,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -92192,20 +114226,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "indicatorGroupDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIndicatorGroup", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorGroupDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIndicatorGroupsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -92220,18 +114258,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor" - } - } - }, - "description": "The JSON representation of the IndicatorGroup resource to be created or updated.", - "required": true, - "x-bodyName": "IndicatorGroup" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -92249,7 +114275,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "indicatorGroupDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIndicatorGroupsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "indicatorGroupDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIndicatorGroup", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor" + } + } + }, + "description": "The JSON representation of the IndicatorGroup resource to be created or updated.", + "required": true, + "x-bodyName": "IndicatorGroup" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92474,6 +114615,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IndicatorLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IndicatorLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IndicatorLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -92590,7 +114792,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92633,7 +114835,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92653,27 +114855,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/indicatorLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIndicatorLevelsById", + "/ed-fi/indicatorLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -92687,48 +114902,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "indicatorLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIndicatorLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -92736,14 +114940,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -92755,20 +114959,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "indicatorLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIndicatorLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIndicatorLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -92783,18 +114991,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor" - } - } - }, - "description": "The JSON representation of the IndicatorLevel resource to be created or updated.", - "required": true, - "x-bodyName": "IndicatorLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -92812,7 +115008,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "indicatorLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIndicatorLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "indicatorLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIndicatorLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor" + } + } + }, + "description": "The JSON representation of the IndicatorLevel resource to be created or updated.", + "required": true, + "x-bodyName": "IndicatorLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93037,6 +115348,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -93153,7 +115525,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93196,7 +115568,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93216,27 +115588,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/institutionTelephoneNumberTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInstitutionTelephoneNumberTypesById", + "/ed-fi/institutionTelephoneNumberTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInstitutionTelephoneNumberTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -93250,48 +115635,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "institutionTelephoneNumberTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/institutionTelephoneNumberTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInstitutionTelephoneNumberTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInstitutionTelephoneNumberTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -93299,14 +115673,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -93318,20 +115692,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "institutionTelephoneNumberTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInstitutionTelephoneNumberType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/institutionTelephoneNumberTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInstitutionTelephoneNumberTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -93346,18 +115724,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor" - } - } - }, - "description": "The JSON representation of the InstitutionTelephoneNumberType resource to be created or updated.", - "required": true, - "x-bodyName": "InstitutionTelephoneNumberType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -93375,7 +115741,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "institutionTelephoneNumberTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInstitutionTelephoneNumberTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "institutionTelephoneNumberTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInstitutionTelephoneNumberType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor" + } + } + }, + "description": "The JSON representation of the InstitutionTelephoneNumberType resource to be created or updated.", + "required": true, + "x-bodyName": "InstitutionTelephoneNumberType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93600,6 +116081,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InteractivityStyleDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InteractivityStyleDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InteractivityStyleDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -93716,7 +116258,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93759,7 +116301,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93779,27 +116321,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/interactivityStyleDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInteractivityStylesById", + "/ed-fi/interactivityStyleDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInteractivityStylesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -93813,48 +116368,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interactivityStyleDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interactivityStyleDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInteractivityStylesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInteractivityStylesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -93862,14 +116406,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -93881,20 +116425,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interactivityStyleDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInteractivityStyle", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interactivityStyleDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInteractivityStylesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -93909,18 +116457,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor" - } - } - }, - "description": "The JSON representation of the InteractivityStyle resource to be created or updated.", - "required": true, - "x-bodyName": "InteractivityStyle" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -93938,7 +116474,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interactivityStyleDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInteractivityStylesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interactivityStyleDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInteractivityStyle", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor" + } + } + }, + "description": "The JSON representation of the InteractivityStyle resource to be created or updated.", + "required": true, + "x-bodyName": "InteractivityStyle" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94163,6 +116814,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InternetAccessDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InternetAccessDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InternetAccessDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -94279,7 +116991,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94322,7 +117034,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94342,27 +117054,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/internetAccessDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInternetAccessesById", + "/ed-fi/internetAccessDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -94376,48 +117101,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "internetAccessDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetAccessDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInternetAccessesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -94425,14 +117139,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -94444,20 +117158,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "internetAccessDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInternetAccess", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetAccessDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInternetAccessesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -94472,18 +117190,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor" - } - } - }, - "description": "The JSON representation of the InternetAccess resource to be created or updated.", - "required": true, - "x-bodyName": "InternetAccess" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -94501,7 +117207,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "internetAccessDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInternetAccessesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "internetAccessDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInternetAccess", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor" + } + } + }, + "description": "The JSON representation of the InternetAccess resource to be created or updated.", + "required": true, + "x-bodyName": "InternetAccess" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94726,6 +117547,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -94842,7 +117724,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94885,7 +117767,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94905,27 +117787,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/internetAccessTypeInResidenceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInternetAccessTypeInResidencesById", + "/ed-fi/internetAccessTypeInResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessTypeInResidencesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -94939,48 +117834,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "internetAccessTypeInResidenceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetAccessTypeInResidenceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInternetAccessTypeInResidencesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessTypeInResidencesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -94988,14 +117872,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -95007,20 +117891,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "internetAccessTypeInResidenceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInternetAccessTypeInResidence", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetAccessTypeInResidenceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInternetAccessTypeInResidencesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -95035,18 +117923,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor" - } - } - }, - "description": "The JSON representation of the InternetAccessTypeInResidence resource to be created or updated.", - "required": true, - "x-bodyName": "InternetAccessTypeInResidence" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -95064,7 +117940,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "internetAccessTypeInResidenceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInternetAccessTypeInResidencesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "internetAccessTypeInResidenceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInternetAccessTypeInResidence", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor" + } + } + }, + "description": "The JSON representation of the InternetAccessTypeInResidence resource to be created or updated.", + "required": true, + "x-bodyName": "InternetAccessTypeInResidence" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95289,6 +118280,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -95405,7 +118457,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95448,7 +118500,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95468,27 +118520,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/internetPerformanceInResidenceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInternetPerformanceInResidencesById", + "/ed-fi/internetPerformanceInResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInternetPerformanceInResidencesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -95502,48 +118567,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "internetPerformanceInResidenceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetPerformanceInResidenceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInternetPerformanceInResidencesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInternetPerformanceInResidencesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -95551,14 +118605,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -95570,20 +118624,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "internetPerformanceInResidenceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInternetPerformanceInResidence", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetPerformanceInResidenceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInternetPerformanceInResidencesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -95598,18 +118656,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor" - } - } - }, - "description": "The JSON representation of the InternetPerformanceInResidence resource to be created or updated.", - "required": true, - "x-bodyName": "InternetPerformanceInResidence" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -95627,7 +118673,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "internetPerformanceInResidenceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInternetPerformanceInResidencesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "internetPerformanceInResidenceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInternetPerformanceInResidence", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor" + } + } + }, + "description": "The JSON representation of the InternetPerformanceInResidence resource to be created or updated.", + "required": true, + "x-bodyName": "InternetPerformanceInResidence" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95852,6 +119013,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InterventionClassDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionClassDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InterventionClassDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -95968,7 +119190,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -96011,7 +119233,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96031,27 +119253,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/interventionClassDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInterventionClassesById", + "/ed-fi/interventionClassDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionClassesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -96065,48 +119300,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interventionClassDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interventionClassDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInterventionClassesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionClassesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -96114,14 +119338,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -96133,20 +119357,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interventionClassDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInterventionClass", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interventionClassDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInterventionClassesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -96161,18 +119389,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor" - } - } - }, - "description": "The JSON representation of the InterventionClass resource to be created or updated.", - "required": true, - "x-bodyName": "InterventionClass" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -96190,7 +119406,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interventionClassDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInterventionClassesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interventionClassDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInterventionClass", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor" + } + } + }, + "description": "The JSON representation of the InterventionClass resource to be created or updated.", + "required": true, + "x-bodyName": "InterventionClass" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96415,6 +119746,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -96531,7 +119923,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -96574,7 +119966,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96594,27 +119986,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/interventionEffectivenessRatingDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInterventionEffectivenessRatingsById", + "/ed-fi/interventionEffectivenessRatingDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionEffectivenessRatingsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -96628,48 +120033,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interventionEffectivenessRatingDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interventionEffectivenessRatingDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInterventionEffectivenessRatingsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionEffectivenessRatingsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -96677,14 +120071,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -96696,20 +120090,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interventionEffectivenessRatingDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInterventionEffectivenessRating", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interventionEffectivenessRatingDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInterventionEffectivenessRatingsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -96724,18 +120122,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor" - } - } - }, - "description": "The JSON representation of the InterventionEffectivenessRating resource to be created or updated.", - "required": true, - "x-bodyName": "InterventionEffectivenessRating" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -96753,7 +120139,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interventionEffectivenessRatingDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInterventionEffectivenessRatingsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interventionEffectivenessRatingDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInterventionEffectivenessRating", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor" + } + } + }, + "description": "The JSON representation of the InterventionEffectivenessRating resource to be created or updated.", + "required": true, + "x-bodyName": "InterventionEffectivenessRating" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -97469,6 +120970,68 @@ "interventionPrescriptionIdentificationCode" ], "type": "object" + }, + "EdFi_InterventionPrescription_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionPrescription_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionPrescriptionIdentificationCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ], + "type": "object" + }, + "EdFi_InterventionPrescription_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -97596,7 +121159,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97639,7 +121202,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -97660,27 +121223,40 @@ "Intervention" ] }, - "/ed-fi/interventionPrescriptions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInterventionPrescriptionsById", + "/ed-fi/interventionPrescriptions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionPrescriptionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -97694,48 +121270,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interventionPrescriptions" ] }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/interventionPrescriptions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInterventionPrescriptionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionPrescriptionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -97743,14 +121309,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InterventionPrescription" + "items": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -97762,20 +121328,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interventionPrescriptions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInterventionPrescription", + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/interventionPrescriptions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInterventionPrescriptionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -97790,18 +121361,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InterventionPrescription" - } - } - }, - "description": "The JSON representation of the InterventionPrescription resource to be created or updated.", - "required": true, - "x-bodyName": "InterventionPrescription" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -97819,7 +121378,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interventionPrescriptions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInterventionPrescriptionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interventionPrescriptions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInterventionPrescription", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription" + } + } + }, + "description": "The JSON representation of the InterventionPrescription resource to be created or updated.", + "required": true, + "x-bodyName": "InterventionPrescription" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98694,6 +122368,68 @@ "stateAbbreviationDescriptor" ], "type": "object" + }, + "EdFi_InterventionStudy_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionStudy_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionStudyIdentificationCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionStudyIdentificationCode" + ], + "type": "object" + }, + "EdFi_InterventionStudy_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -98823,7 +122559,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98866,7 +122602,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98887,27 +122623,40 @@ "Intervention" ] }, - "/ed-fi/interventionStudies/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInterventionStudiesById", + "/ed-fi/interventionStudies/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionStudiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -98921,48 +122670,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interventionStudies" ] }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/interventionStudies/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInterventionStudiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionStudiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -98970,14 +122709,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InterventionStudy" + "items": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -98989,20 +122728,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interventionStudies" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInterventionStudy", + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/interventionStudies/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInterventionStudiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -99017,18 +122761,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InterventionStudy" - } - } - }, - "description": "The JSON representation of the InterventionStudy resource to be created or updated.", - "required": true, - "x-bodyName": "InterventionStudy" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -99046,7 +122778,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interventionStudies" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInterventionStudiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionStudy" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interventionStudies" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInterventionStudy", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionStudy" + } + } + }, + "description": "The JSON representation of the InterventionStudy resource to be created or updated.", + "required": true, + "x-bodyName": "InterventionStudy" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100029,6 +123876,68 @@ "staffReference" ], "type": "object" + }, + "EdFi_Intervention_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Intervention_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionIdentificationCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionIdentificationCode" + ], + "type": "object" + }, + "EdFi_Intervention_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -100174,7 +124083,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100217,7 +124126,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100239,27 +124148,40 @@ "StudentCohort" ] }, - "/ed-fi/interventions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInterventionsById", + "/ed-fi/interventions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -100273,48 +124195,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interventions" ] }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/interventions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInterventionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -100322,14 +124235,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Intervention" + "items": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -100341,20 +124254,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interventions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIntervention", + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/interventions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInterventionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -100369,18 +124288,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Intervention" - } - } - }, - "description": "The JSON representation of the Intervention resource to be created or updated.", - "required": true, - "x-bodyName": "Intervention" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -100398,7 +124305,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interventions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInterventionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Intervention" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interventions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIntervention", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Intervention" + } + } + }, + "description": "The JSON representation of the Intervention resource to be created or updated.", + "required": true, + "x-bodyName": "Intervention" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100651,6 +124673,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LanguageDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LanguageDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LanguageDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -100767,7 +124850,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100810,7 +124893,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100830,27 +124913,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/languageDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLanguagesById", + "/ed-fi/languageDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLanguagesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -100864,48 +124960,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "languageDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLanguagesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLanguagesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -100913,14 +124998,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LanguageDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -100932,20 +125017,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "languageDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLanguage", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLanguagesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -100960,18 +125049,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LanguageDescriptor" - } - } - }, - "description": "The JSON representation of the Language resource to be created or updated.", - "required": true, - "x-bodyName": "Language" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -100989,7 +125066,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "languageDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLanguagesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "languageDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLanguage", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor" + } + } + }, + "description": "The JSON representation of the Language resource to be created or updated.", + "required": true, + "x-bodyName": "Language" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -101214,6 +125406,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -101330,7 +125583,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -101373,7 +125626,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -101393,27 +125646,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/languageInstructionProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLanguageInstructionProgramServicesById", + "/ed-fi/languageInstructionProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageInstructionProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -101427,48 +125693,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "languageInstructionProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageInstructionProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLanguageInstructionProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageInstructionProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -101476,14 +125731,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -101495,20 +125750,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "languageInstructionProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLanguageInstructionProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageInstructionProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLanguageInstructionProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -101523,18 +125782,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the LanguageInstructionProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "LanguageInstructionProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -101552,7 +125799,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "languageInstructionProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLanguageInstructionProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "languageInstructionProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLanguageInstructionProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the LanguageInstructionProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "LanguageInstructionProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -101777,6 +126139,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LanguageUseDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LanguageUseDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LanguageUseDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -101893,7 +126316,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -101936,7 +126359,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -101956,27 +126379,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/languageUseDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLanguageUsesById", + "/ed-fi/languageUseDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageUsesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -101990,48 +126426,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "languageUseDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageUseDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLanguageUsesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageUsesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -102039,14 +126464,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -102058,20 +126483,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "languageUseDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLanguageUse", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageUseDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLanguageUsesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -102086,18 +126515,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor" - } - } - }, - "description": "The JSON representation of the LanguageUse resource to be created or updated.", - "required": true, - "x-bodyName": "LanguageUse" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -102115,7 +126532,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "languageUseDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLanguageUsesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "languageUseDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLanguageUse", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor" + } + } + }, + "description": "The JSON representation of the LanguageUse resource to be created or updated.", + "required": true, + "x-bodyName": "LanguageUse" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -102340,6 +126872,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LearningStandardCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LearningStandardCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -102456,7 +127049,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102499,7 +127092,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -102519,27 +127112,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/learningStandardCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLearningStandardCategoriesById", + "/ed-fi/learningStandardCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -102553,48 +127159,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "learningStandardCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLearningStandardCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -102602,14 +127197,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -102621,20 +127216,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "learningStandardCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLearningStandardCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLearningStandardCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -102649,18 +127248,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the LearningStandardCategory resource to be created or updated.", - "required": true, - "x-bodyName": "LearningStandardCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -102678,7 +127265,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "learningStandardCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLearningStandardCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "learningStandardCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLearningStandardCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the LearningStandardCategory resource to be created or updated.", + "required": true, + "x-bodyName": "LearningStandardCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -103011,6 +127713,75 @@ "targetLearningStandardId" ], "type": "object" + }, + "EdFi_LearningStandardEquivalenceAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "sourceLearningStandardId": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "targetLearningStandardId": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "namespace", + "sourceLearningStandardId", + "targetLearningStandardId" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -103132,7 +127903,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -103175,7 +127946,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -103195,27 +127966,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/learningStandardEquivalenceAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLearningStandardEquivalenceAssociationsById", + "/ed-fi/learningStandardEquivalenceAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -103229,48 +128013,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "learningStandardEquivalenceAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardEquivalenceAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLearningStandardEquivalenceAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -103278,14 +128051,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -103297,20 +128070,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "learningStandardEquivalenceAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLearningStandardEquivalenceAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardEquivalenceAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLearningStandardEquivalenceAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -103325,18 +128102,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation" - } - } - }, - "description": "The JSON representation of the LearningStandardEquivalenceAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "LearningStandardEquivalenceAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -103354,7 +128119,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "learningStandardEquivalenceAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLearningStandardEquivalenceAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "learningStandardEquivalenceAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLearningStandardEquivalenceAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation" + } + } + }, + "description": "The JSON representation of the LearningStandardEquivalenceAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "LearningStandardEquivalenceAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -103585,6 +128465,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -103701,7 +128642,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -103744,7 +128685,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -103764,27 +128705,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/learningStandardEquivalenceStrengthDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLearningStandardEquivalenceStrengthsById", + "/ed-fi/learningStandardEquivalenceStrengthDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceStrengthsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -103798,48 +128752,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "learningStandardEquivalenceStrengthDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardEquivalenceStrengthDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLearningStandardEquivalenceStrengthsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceStrengthsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -103847,14 +128790,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -103866,20 +128809,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "learningStandardEquivalenceStrengthDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLearningStandardEquivalenceStrength", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardEquivalenceStrengthDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLearningStandardEquivalenceStrengthsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -103894,18 +128841,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor" - } - } - }, - "description": "The JSON representation of the LearningStandardEquivalenceStrength resource to be created or updated.", - "required": true, - "x-bodyName": "LearningStandardEquivalenceStrength" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -103923,7 +128858,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "learningStandardEquivalenceStrengthDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLearningStandardEquivalenceStrengthsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "learningStandardEquivalenceStrengthDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLearningStandardEquivalenceStrength", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor" + } + } + }, + "description": "The JSON representation of the LearningStandardEquivalenceStrength resource to be created or updated.", + "required": true, + "x-bodyName": "LearningStandardEquivalenceStrength" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -104148,6 +129198,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LearningStandardScopeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardScopeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LearningStandardScopeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -104264,7 +129375,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104307,7 +129418,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -104327,27 +129438,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/learningStandardScopeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLearningStandardScopesById", + "/ed-fi/learningStandardScopeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardScopesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -104361,48 +129485,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "learningStandardScopeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardScopeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLearningStandardScopesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardScopesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -104410,14 +129523,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -104429,20 +129542,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "learningStandardScopeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLearningStandardScope", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardScopeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLearningStandardScopesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -104457,18 +129574,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor" - } - } - }, - "description": "The JSON representation of the LearningStandardScope resource to be created or updated.", - "required": true, - "x-bodyName": "LearningStandardScope" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -104486,7 +129591,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "learningStandardScopeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLearningStandardScopesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "learningStandardScopeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLearningStandardScope", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor" + } + } + }, + "description": "The JSON representation of the LearningStandardScope resource to be created or updated.", + "required": true, + "x-bodyName": "LearningStandardScope" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -105329,6 +130549,63 @@ "learningStandardId" ], "type": "object" + }, + "EdFi_LearningStandard_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandard_TrackedChangeKey": { + "properties": { + "learningStandardId": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "learningStandardId" + ], + "type": "object" + }, + "EdFi_LearningStandard_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -105489,7 +130766,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -105532,7 +130809,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -105558,27 +130835,40 @@ "Standards" ] }, - "/ed-fi/learningStandards/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLearningStandardsById", + "/ed-fi/learningStandards/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -105592,48 +130882,43 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "learningStandards" ] }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "Standards" + ] + }, + "/ed-fi/learningStandards/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLearningStandardsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -105641,14 +130926,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandard" + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -105660,20 +130945,30 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "learningStandards" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLearningStandard", + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "Standards" + ] + }, + "/ed-fi/learningStandards/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLearningStandardsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -105688,18 +130983,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandard" - } - } - }, - "description": "The JSON representation of the LearningStandard resource to be created or updated.", - "required": true, - "x-bodyName": "LearningStandard" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -105717,7 +131000,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "learningStandards" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLearningStandardsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandard" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "learningStandards" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLearningStandard", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandard" + } + } + }, + "description": "The JSON representation of the LearningStandard resource to be created or updated.", + "required": true, + "x-bodyName": "LearningStandard" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -105979,6 +131377,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LevelOfEducationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LevelOfEducationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LevelOfEducationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -106095,7 +131554,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106138,7 +131597,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106158,27 +131617,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/levelOfEducationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLevelOfEducationsById", + "/ed-fi/levelOfEducationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLevelOfEducationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -106192,48 +131664,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "levelOfEducationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/levelOfEducationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLevelOfEducationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLevelOfEducationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -106241,14 +131702,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -106260,20 +131721,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "levelOfEducationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLevelOfEducation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/levelOfEducationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLevelOfEducationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -106288,18 +131753,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor" - } - } - }, - "description": "The JSON representation of the LevelOfEducation resource to be created or updated.", - "required": true, - "x-bodyName": "LevelOfEducation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -106317,7 +131770,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "levelOfEducationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLevelOfEducationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "levelOfEducationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLevelOfEducation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor" + } + } + }, + "description": "The JSON representation of the LevelOfEducation resource to be created or updated.", + "required": true, + "x-bodyName": "LevelOfEducation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106542,6 +132110,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LicenseStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LicenseStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LicenseStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -106658,7 +132287,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106701,7 +132330,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106721,27 +132350,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/licenseStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLicenseStatusesById", + "/ed-fi/licenseStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -106755,48 +132397,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "licenseStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/licenseStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLicenseStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -106804,14 +132435,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -106823,20 +132454,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "licenseStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLicenseStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/licenseStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLicenseStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -106851,18 +132486,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor" - } - } - }, - "description": "The JSON representation of the LicenseStatus resource to be created or updated.", - "required": true, - "x-bodyName": "LicenseStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -106880,7 +132503,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "licenseStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLicenseStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "licenseStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLicenseStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor" + } + } + }, + "description": "The JSON representation of the LicenseStatus resource to be created or updated.", + "required": true, + "x-bodyName": "LicenseStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107105,6 +132843,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LicenseTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LicenseTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LicenseTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -107221,7 +133020,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107264,7 +133063,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107284,27 +133083,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/licenseTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLicenseTypesById", + "/ed-fi/licenseTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -107318,48 +133130,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "licenseTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/licenseTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLicenseTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -107367,14 +133168,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -107386,20 +133187,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "licenseTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLicenseType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/licenseTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLicenseTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -107414,18 +133219,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor" - } - } - }, - "description": "The JSON representation of the LicenseType resource to be created or updated.", - "required": true, - "x-bodyName": "LicenseType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -107443,7 +133236,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "licenseTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLicenseTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "licenseTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLicenseType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor" + } + } + }, + "description": "The JSON representation of the LicenseType resource to be created or updated.", + "required": true, + "x-bodyName": "LicenseType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107668,6 +133576,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -107784,7 +133753,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107827,7 +133796,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107847,27 +133816,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/limitedEnglishProficiencyDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLimitedEnglishProficienciesById", + "/ed-fi/limitedEnglishProficiencyDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLimitedEnglishProficienciesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -107881,48 +133863,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "limitedEnglishProficiencyDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/limitedEnglishProficiencyDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLimitedEnglishProficienciesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLimitedEnglishProficienciesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -107930,14 +133901,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -107949,20 +133920,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "limitedEnglishProficiencyDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLimitedEnglishProficiency", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/limitedEnglishProficiencyDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLimitedEnglishProficienciesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -107977,18 +133952,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor" - } - } - }, - "description": "The JSON representation of the LimitedEnglishProficiency resource to be created or updated.", - "required": true, - "x-bodyName": "LimitedEnglishProficiency" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -108006,7 +133969,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "limitedEnglishProficiencyDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLimitedEnglishProficienciesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "limitedEnglishProficiencyDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLimitedEnglishProficiency", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor" + } + } + }, + "description": "The JSON representation of the LimitedEnglishProficiency resource to be created or updated.", + "required": true, + "x-bodyName": "LimitedEnglishProficiency" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108426,6 +134504,73 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_LocalAccount_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalAccount_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalAccount_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -108547,7 +134692,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108590,7 +134735,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108611,27 +134756,40 @@ "Finance" ] }, - "/ed-fi/localAccounts/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalAccountsById", + "/ed-fi/localAccounts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalAccountsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -108645,48 +134803,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localAccounts" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localAccounts/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalAccountsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalAccountsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -108694,14 +134842,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalAccount" + "items": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -108713,20 +134861,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localAccounts" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalAccount", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localAccounts/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalAccountsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -108741,18 +134894,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalAccount" - } - } - }, - "description": "The JSON representation of the LocalAccount resource to be created or updated.", - "required": true, - "x-bodyName": "LocalAccount" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -108770,7 +134911,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localAccounts" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalAccountsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalAccount" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localAccounts" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalAccount", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalAccount" + } + } + }, + "description": "The JSON representation of the LocalAccount resource to be created or updated.", + "required": true, + "x-bodyName": "LocalAccount" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109093,6 +135349,78 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_LocalActual_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalActual_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalActual_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -109212,7 +135540,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109255,7 +135583,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109276,27 +135604,40 @@ "Finance" ] }, - "/ed-fi/localActuals/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalActualsById", + "/ed-fi/localActuals/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalActualsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -109310,48 +135651,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localActuals" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localActuals/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalActualsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalActualsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -109359,14 +135690,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalActual" + "items": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -109378,20 +135709,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localActuals" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalActual", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localActuals/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalActualsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -109406,18 +135742,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalActual" - } - } - }, - "description": "The JSON representation of the LocalActual resource to be created or updated.", - "required": true, - "x-bodyName": "LocalActual" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -109435,7 +135759,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localActuals" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalActualsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalActual" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localActuals" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalActual", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalActual" + } + } + }, + "description": "The JSON representation of the LocalActual resource to be created or updated.", + "required": true, + "x-bodyName": "LocalActual" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109753,6 +136192,78 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_LocalBudget_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalBudget_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalBudget_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -109872,7 +136383,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109915,7 +136426,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109936,27 +136447,40 @@ "Finance" ] }, - "/ed-fi/localBudgets/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalBudgetsById", + "/ed-fi/localBudgets/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalBudgetsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -109970,48 +136494,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localBudgets" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localBudgets/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalBudgetsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalBudgetsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -110019,14 +136533,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalBudget" + "items": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -110038,20 +136552,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localBudgets" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalBudget", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localBudgets/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalBudgetsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -110066,18 +136585,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalBudget" - } - } - }, - "description": "The JSON representation of the LocalBudget resource to be created or updated.", - "required": true, - "x-bodyName": "LocalBudget" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -110095,7 +136602,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localBudgets" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalBudgetsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalBudget" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localBudgets" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalBudget", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalBudget" + } + } + }, + "description": "The JSON representation of the LocalBudget resource to be created or updated.", + "required": true, + "x-bodyName": "LocalBudget" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -110459,6 +137081,84 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_LocalContractedStaff_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalContractedStaff_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_LocalContractedStaff_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -110589,7 +137289,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110632,7 +137332,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -110653,27 +137353,40 @@ "Finance" ] }, - "/ed-fi/localContractedStaffs/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalContractedStaffsById", + "/ed-fi/localContractedStaffs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalContractedStaffsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -110687,48 +137400,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localContractedStaffs" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localContractedStaffs/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalContractedStaffsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalContractedStaffsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -110736,14 +137439,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalContractedStaff" + "items": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -110755,20 +137458,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localContractedStaffs" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalContractedStaff", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localContractedStaffs/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalContractedStaffsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -110783,18 +137491,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalContractedStaff" - } - } - }, - "description": "The JSON representation of the LocalContractedStaff resource to be created or updated.", - "required": true, - "x-bodyName": "LocalContractedStaff" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -110812,7 +137508,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localContractedStaffs" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalContractedStaffsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localContractedStaffs" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalContractedStaff", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff" + } + } + }, + "description": "The JSON representation of the LocalContractedStaff resource to be created or updated.", + "required": true, + "x-bodyName": "LocalContractedStaff" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112621,6 +139432,62 @@ "localEducationAgencyId" ], "type": "object" + }, + "EdFi_LocalEducationAgency_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalEducationAgency_TrackedChangeKey": { + "properties": { + "localEducationAgencyId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "localEducationAgencyId" + ], + "type": "object" + }, + "EdFi_LocalEducationAgency_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -112778,7 +139645,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112821,7 +139688,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112844,27 +139711,40 @@ "Staff" ] }, - "/ed-fi/localEducationAgencies/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalEducationAgenciesById", + "/ed-fi/localEducationAgencies/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgenciesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -112878,48 +139758,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localEducationAgencies" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, + "/ed-fi/localEducationAgencies/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalEducationAgenciesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgenciesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -112927,14 +139799,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalEducationAgency" + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -112946,20 +139818,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localEducationAgencies" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalEducationAgency", + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, + "/ed-fi/localEducationAgencies/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalEducationAgenciesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -112974,18 +139853,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalEducationAgency" - } - } - }, - "description": "The JSON representation of the LocalEducationAgency resource to be created or updated.", - "required": true, - "x-bodyName": "LocalEducationAgency" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -113003,7 +139870,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localEducationAgencies" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalEducationAgenciesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localEducationAgencies" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalEducationAgency", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency" + } + } + }, + "description": "The JSON representation of the LocalEducationAgency resource to be created or updated.", + "required": true, + "x-bodyName": "LocalEducationAgency" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -113272,6 +140254,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -113388,7 +140431,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -113431,7 +140474,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -113451,27 +140494,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/localEducationAgencyCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalEducationAgencyCategoriesById", + "/ed-fi/localEducationAgencyCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgencyCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -113485,48 +140541,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localEducationAgencyCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/localEducationAgencyCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalEducationAgencyCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgencyCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -113534,14 +140579,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -113553,20 +140598,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localEducationAgencyCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalEducationAgencyCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/localEducationAgencyCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalEducationAgencyCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -113581,18 +140630,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the LocalEducationAgencyCategory resource to be created or updated.", - "required": true, - "x-bodyName": "LocalEducationAgencyCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -113610,7 +140647,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localEducationAgencyCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalEducationAgencyCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localEducationAgencyCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalEducationAgencyCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the LocalEducationAgencyCategory resource to be created or updated.", + "required": true, + "x-bodyName": "LocalEducationAgencyCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -113924,6 +141076,78 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_LocalEncumbrance_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalEncumbrance_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalEncumbrance_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -114043,7 +141267,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114086,7 +141310,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -114107,27 +141331,40 @@ "Finance" ] }, - "/ed-fi/localEncumbrances/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalEncumbrancesById", + "/ed-fi/localEncumbrances/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEncumbrancesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -114141,48 +141378,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localEncumbrances" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localEncumbrances/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalEncumbrancesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEncumbrancesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -114190,14 +141417,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalEncumbrance" + "items": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -114209,20 +141436,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localEncumbrances" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalEncumbrance", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localEncumbrances/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalEncumbrancesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -114237,18 +141469,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalEncumbrance" - } - } - }, - "description": "The JSON representation of the LocalEncumbrance resource to be created or updated.", - "required": true, - "x-bodyName": "LocalEncumbrance" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -114266,7 +141486,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localEncumbrances" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalEncumbrancesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localEncumbrances" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalEncumbrance", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance" + } + } + }, + "description": "The JSON representation of the LocalEncumbrance resource to be created or updated.", + "required": true, + "x-bodyName": "LocalEncumbrance" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -114630,6 +141965,84 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_LocalPayroll_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalPayroll_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_LocalPayroll_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -114760,7 +142173,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114803,7 +142216,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -114824,27 +142237,40 @@ "Finance" ] }, - "/ed-fi/localPayrolls/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalPayrollsById", + "/ed-fi/localPayrolls/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalPayrollsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -114858,48 +142284,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localPayrolls" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localPayrolls/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalPayrollsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalPayrollsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -114907,14 +142323,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalPayroll" + "items": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -114926,20 +142342,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localPayrolls" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalPayroll", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localPayrolls/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalPayrollsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -114954,18 +142375,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalPayroll" - } - } - }, - "description": "The JSON representation of the LocalPayroll resource to be created or updated.", - "required": true, - "x-bodyName": "LocalPayroll" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -114983,7 +142392,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localPayrolls" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalPayrollsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalPayroll" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localPayrolls" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalPayroll", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalPayroll" + } + } + }, + "description": "The JSON representation of the LocalPayroll resource to be created or updated.", + "required": true, + "x-bodyName": "LocalPayroll" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -115219,6 +142743,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LocaleDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocaleDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LocaleDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -115335,7 +142920,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -115378,7 +142963,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -115398,27 +142983,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/localeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalesById", + "/ed-fi/localeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -115432,48 +143030,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/localeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -115481,14 +143068,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocaleDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -115500,20 +143087,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocale", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/localeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -115528,18 +143119,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocaleDescriptor" - } - } - }, - "description": "The JSON representation of the Locale resource to be created or updated.", - "required": true, - "x-bodyName": "Locale" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -115557,7 +143136,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocale", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor" + } + } + }, + "description": "The JSON representation of the Locale resource to be created or updated.", + "required": true, + "x-bodyName": "Locale" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -115822,6 +143516,68 @@ "schoolId" ], "type": "object" + }, + "EdFi_Location_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Location_TrackedChangeKey": { + "properties": { + "classroomIdentificationCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "classroomIdentificationCode", + "schoolId" + ], + "type": "object" + }, + "EdFi_Location_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -115921,7 +143677,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -115964,7 +143720,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -115986,27 +143742,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/locations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocationsById", + "/ed-fi/locations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -116020,48 +143789,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "locations" ] }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/locations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -116069,14 +143829,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Location" + "items": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -116088,20 +143848,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "locations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocation", + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/locations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -116116,18 +143882,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Location" - } - } - }, - "description": "The JSON representation of the Location resource to be created or updated.", - "required": true, - "x-bodyName": "Location" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -116145,7 +143899,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "locations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Location" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "locations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Location" + } + } + }, + "description": "The JSON representation of the Location resource to be created or updated.", + "required": true, + "x-bodyName": "Location" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -116364,6 +144233,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -116480,7 +144410,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -116523,7 +144453,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -116543,27 +144473,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteMagnetSpecialProgramEmphasisSchoolsById", + "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMagnetSpecialProgramEmphasisSchoolsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -116577,48 +144520,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "magnetSpecialProgramEmphasisSchoolDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getMagnetSpecialProgramEmphasisSchoolsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMagnetSpecialProgramEmphasisSchoolsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -116626,14 +144558,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -116645,20 +144577,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "magnetSpecialProgramEmphasisSchoolDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putMagnetSpecialProgramEmphasisSchool", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteMagnetSpecialProgramEmphasisSchoolsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -116673,18 +144609,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor" - } - } - }, - "description": "The JSON representation of the MagnetSpecialProgramEmphasisSchool resource to be created or updated.", - "required": true, - "x-bodyName": "MagnetSpecialProgramEmphasisSchool" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -116702,7 +144626,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "magnetSpecialProgramEmphasisSchoolDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getMagnetSpecialProgramEmphasisSchoolsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "magnetSpecialProgramEmphasisSchoolDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putMagnetSpecialProgramEmphasisSchool", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor" + } + } + }, + "description": "The JSON representation of the MagnetSpecialProgramEmphasisSchool resource to be created or updated.", + "required": true, + "x-bodyName": "MagnetSpecialProgramEmphasisSchool" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -116927,6 +144966,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MediumOfInstructionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MediumOfInstructionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MediumOfInstructionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -117043,7 +145143,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -117086,7 +145186,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -117106,27 +145206,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/mediumOfInstructionDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteMediumOfInstructionsById", + "/ed-fi/mediumOfInstructionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMediumOfInstructionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -117140,48 +145253,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "mediumOfInstructionDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/mediumOfInstructionDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getMediumOfInstructionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMediumOfInstructionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -117189,14 +145291,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -117208,20 +145310,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "mediumOfInstructionDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putMediumOfInstruction", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/mediumOfInstructionDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteMediumOfInstructionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -117236,18 +145342,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor" - } - } - }, - "description": "The JSON representation of the MediumOfInstruction resource to be created or updated.", - "required": true, - "x-bodyName": "MediumOfInstruction" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -117265,7 +145359,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "mediumOfInstructionDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getMediumOfInstructionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "mediumOfInstructionDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putMediumOfInstruction", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor" + } + } + }, + "description": "The JSON representation of the MediumOfInstruction resource to be created or updated.", + "required": true, + "x-bodyName": "MediumOfInstruction" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -117490,6 +145699,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MethodCreditEarnedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MethodCreditEarnedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -117606,7 +145876,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -117649,7 +145919,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -117669,27 +145939,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/methodCreditEarnedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteMethodCreditEarnedsById", + "/ed-fi/methodCreditEarnedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMethodCreditEarnedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -117703,48 +145986,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "methodCreditEarnedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/methodCreditEarnedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getMethodCreditEarnedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMethodCreditEarnedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -117752,14 +146024,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -117771,20 +146043,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "methodCreditEarnedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putMethodCreditEarned", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/methodCreditEarnedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteMethodCreditEarnedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -117799,18 +146075,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor" - } - } - }, - "description": "The JSON representation of the MethodCreditEarned resource to be created or updated.", - "required": true, - "x-bodyName": "MethodCreditEarned" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -117828,7 +146092,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "methodCreditEarnedDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getMethodCreditEarnedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "methodCreditEarnedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putMethodCreditEarned", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor" + } + } + }, + "description": "The JSON representation of the MethodCreditEarned resource to be created or updated.", + "required": true, + "x-bodyName": "MethodCreditEarned" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118053,6 +146432,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -118169,7 +146609,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118212,7 +146652,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118232,27 +146672,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/migrantEducationProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteMigrantEducationProgramServicesById", + "/ed-fi/migrantEducationProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMigrantEducationProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -118266,48 +146719,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "migrantEducationProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/migrantEducationProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getMigrantEducationProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMigrantEducationProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -118315,14 +146757,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -118334,20 +146776,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "migrantEducationProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putMigrantEducationProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/migrantEducationProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteMigrantEducationProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -118362,18 +146808,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the MigrantEducationProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "MigrantEducationProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -118391,7 +146825,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "migrantEducationProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getMigrantEducationProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "migrantEducationProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putMigrantEducationProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the MigrantEducationProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "MigrantEducationProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118616,6 +147165,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ModelEntityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ModelEntityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ModelEntityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -118732,7 +147342,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118775,7 +147385,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118795,27 +147405,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/modelEntityDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteModelEntitiesById", + "/ed-fi/modelEntityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getModelEntitiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -118829,48 +147452,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "modelEntityDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/modelEntityDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getModelEntitiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getModelEntitiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -118878,14 +147490,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -118897,20 +147509,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "modelEntityDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putModelEntity", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/modelEntityDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteModelEntitiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -118925,18 +147541,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor" - } - } - }, - "description": "The JSON representation of the ModelEntity resource to be created or updated.", - "required": true, - "x-bodyName": "ModelEntity" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -118954,7 +147558,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "modelEntityDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getModelEntitiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "modelEntityDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putModelEntity", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor" + } + } + }, + "description": "The JSON representation of the ModelEntity resource to be created or updated.", + "required": true, + "x-bodyName": "ModelEntity" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119179,6 +147898,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MonitoredDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MonitoredDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MonitoredDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -119295,7 +148075,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119338,7 +148118,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119358,27 +148138,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/monitoredDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteMonitoredsById", + "/ed-fi/monitoredDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMonitoredsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -119392,48 +148185,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "monitoredDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/monitoredDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getMonitoredsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMonitoredsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -119441,14 +148223,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_MonitoredDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -119460,20 +148242,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "monitoredDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putMonitored", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/monitoredDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteMonitoredsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -119488,18 +148274,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_MonitoredDescriptor" - } - } - }, - "description": "The JSON representation of the Monitored resource to be created or updated.", - "required": true, - "x-bodyName": "Monitored" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -119517,7 +148291,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "monitoredDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getMonitoredsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "monitoredDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putMonitored", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor" + } + } + }, + "description": "The JSON representation of the Monitored resource to be created or updated.", + "required": true, + "x-bodyName": "Monitored" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119742,6 +148631,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -119858,7 +148808,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119901,7 +148851,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119921,27 +148871,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/neglectedOrDelinquentProgramDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteNeglectedOrDelinquentProgramsById", + "/ed-fi/neglectedOrDelinquentProgramDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -119955,48 +148918,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "neglectedOrDelinquentProgramDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/neglectedOrDelinquentProgramDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getNeglectedOrDelinquentProgramsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -120004,14 +148956,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -120023,20 +148975,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "neglectedOrDelinquentProgramDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putNeglectedOrDelinquentProgram", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/neglectedOrDelinquentProgramDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteNeglectedOrDelinquentProgramsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -120051,18 +149007,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor" - } - } - }, - "description": "The JSON representation of the NeglectedOrDelinquentProgram resource to be created or updated.", - "required": true, - "x-bodyName": "NeglectedOrDelinquentProgram" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -120080,7 +149024,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "neglectedOrDelinquentProgramDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getNeglectedOrDelinquentProgramsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "neglectedOrDelinquentProgramDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putNeglectedOrDelinquentProgram", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor" + } + } + }, + "description": "The JSON representation of the NeglectedOrDelinquentProgram resource to be created or updated.", + "required": true, + "x-bodyName": "NeglectedOrDelinquentProgram" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120305,6 +149364,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -120421,7 +149541,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120464,7 +149584,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120484,27 +149604,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteNeglectedOrDelinquentProgramServicesById", + "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -120518,48 +149651,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "neglectedOrDelinquentProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getNeglectedOrDelinquentProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -120567,14 +149689,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -120586,20 +149708,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "neglectedOrDelinquentProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putNeglectedOrDelinquentProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteNeglectedOrDelinquentProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -120614,18 +149740,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the NeglectedOrDelinquentProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "NeglectedOrDelinquentProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -120643,7 +149757,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "neglectedOrDelinquentProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getNeglectedOrDelinquentProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "neglectedOrDelinquentProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putNeglectedOrDelinquentProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the NeglectedOrDelinquentProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "NeglectedOrDelinquentProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120868,6 +150097,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NetworkPurposeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NetworkPurposeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NetworkPurposeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -120984,7 +150274,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121027,7 +150317,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121047,27 +150337,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/networkPurposeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteNetworkPurposesById", + "/ed-fi/networkPurposeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNetworkPurposesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -121081,48 +150384,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "networkPurposeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/networkPurposeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getNetworkPurposesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNetworkPurposesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -121130,14 +150422,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -121149,20 +150441,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "networkPurposeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putNetworkPurpose", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/networkPurposeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteNetworkPurposesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -121177,18 +150473,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor" - } - } - }, - "description": "The JSON representation of the NetworkPurpose resource to be created or updated.", - "required": true, - "x-bodyName": "NetworkPurpose" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -121206,7 +150490,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "networkPurposeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getNetworkPurposesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "networkPurposeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putNetworkPurpose", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor" + } + } + }, + "description": "The JSON representation of the NetworkPurpose resource to be created or updated.", + "required": true, + "x-bodyName": "NetworkPurpose" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121498,6 +150897,68 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ObjectDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ObjectDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "minLength": 1, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ObjectDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -121589,7 +151050,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121632,7 +151093,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121653,27 +151114,40 @@ "Finance" ] }, - "/ed-fi/objectDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteObjectDimensionsById", + "/ed-fi/objectDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getObjectDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -121687,48 +151161,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "objectDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/objectDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getObjectDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getObjectDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -121736,14 +151200,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ObjectDimension" + "items": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -121755,20 +151219,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "objectDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putObjectDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/objectDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteObjectDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -121783,18 +151252,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ObjectDimension" - } - } - }, - "description": "The JSON representation of the ObjectDimension resource to be created or updated.", - "required": true, - "x-bodyName": "ObjectDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -121812,7 +151269,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "objectDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getObjectDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ObjectDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "objectDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putObjectDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ObjectDimension" + } + } + }, + "description": "The JSON representation of the ObjectDimension resource to be created or updated.", + "required": true, + "x-bodyName": "ObjectDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -122658,6 +152230,75 @@ "identificationCode" ], "type": "object" + }, + "EdFi_ObjectiveAssessment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ObjectiveAssessment_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "identificationCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "identificationCode", + "namespace" + ], + "type": "object" + }, + "EdFi_ObjectiveAssessment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -122809,7 +152450,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122852,7 +152493,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -122874,27 +152515,40 @@ "AssessmentMetadata" ] }, - "/ed-fi/objectiveAssessments/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteObjectiveAssessmentsById", + "/ed-fi/objectiveAssessments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getObjectiveAssessmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -122908,48 +152562,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "objectiveAssessments" ] }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/objectiveAssessments/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getObjectiveAssessmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getObjectiveAssessmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -122957,14 +152602,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ObjectiveAssessment" + "items": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -122976,20 +152621,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "objectiveAssessments" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putObjectiveAssessment", + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/objectiveAssessments/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteObjectiveAssessmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -123004,18 +152655,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ObjectiveAssessment" - } - } - }, - "description": "The JSON representation of the ObjectiveAssessment resource to be created or updated.", - "required": true, - "x-bodyName": "ObjectiveAssessment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -123033,7 +152672,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "objectiveAssessments" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getObjectiveAssessmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "objectiveAssessments" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putObjectiveAssessment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment" + } + } + }, + "description": "The JSON representation of the ObjectiveAssessment resource to be created or updated.", + "required": true, + "x-bodyName": "ObjectiveAssessment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -123544,6 +153298,68 @@ "requisitionNumber" ], "type": "object" + }, + "EdFi_OpenStaffPosition_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OpenStaffPosition_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "requisitionNumber": { + "maxLength": 20, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "requisitionNumber" + ], + "type": "object" + }, + "EdFi_OpenStaffPosition_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -123689,7 +153505,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123732,7 +153548,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -123753,27 +153569,40 @@ "Staff" ] }, - "/ed-fi/openStaffPositions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteOpenStaffPositionsById", + "/ed-fi/openStaffPositions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -123787,48 +153616,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "openStaffPositions" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/openStaffPositions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getOpenStaffPositionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -123836,14 +153655,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_OpenStaffPosition" + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -123855,20 +153674,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "openStaffPositions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putOpenStaffPosition", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/openStaffPositions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteOpenStaffPositionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -123883,18 +153707,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_OpenStaffPosition" - } - } - }, - "description": "The JSON representation of the OpenStaffPosition resource to be created or updated.", - "required": true, - "x-bodyName": "OpenStaffPosition" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -123912,7 +153724,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "openStaffPositions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getOpenStaffPositionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "openStaffPositions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putOpenStaffPosition", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition" + } + } + }, + "description": "The JSON representation of the OpenStaffPosition resource to be created or updated.", + "required": true, + "x-bodyName": "OpenStaffPosition" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124159,6 +154086,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_OperationalStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OperationalStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_OperationalStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -124275,7 +154263,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124318,7 +154306,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124338,27 +154326,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/operationalStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteOperationalStatusesById", + "/ed-fi/operationalStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -124372,48 +154373,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "operationalStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/operationalStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getOperationalStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -124421,14 +154411,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -124440,20 +154430,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "operationalStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putOperationalStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/operationalStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteOperationalStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -124468,18 +154462,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor" - } - } - }, - "description": "The JSON representation of the OperationalStatus resource to be created or updated.", - "required": true, - "x-bodyName": "OperationalStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -124497,7 +154479,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "operationalStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getOperationalStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "operationalStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putOperationalStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor" + } + } + }, + "description": "The JSON representation of the OperationalStatus resource to be created or updated.", + "required": true, + "x-bodyName": "OperationalStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124789,6 +154886,68 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_OperationalUnitDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OperationalUnitDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "minLength": 1, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_OperationalUnitDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -124880,7 +155039,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124923,7 +155082,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124944,27 +155103,40 @@ "Finance" ] }, - "/ed-fi/operationalUnitDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteOperationalUnitDimensionsById", + "/ed-fi/operationalUnitDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalUnitDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -124978,48 +155150,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "operationalUnitDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/operationalUnitDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getOperationalUnitDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalUnitDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -125027,14 +155189,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_OperationalUnitDimension" + "items": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -125046,20 +155208,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "operationalUnitDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putOperationalUnitDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/operationalUnitDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteOperationalUnitDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -125074,18 +155241,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_OperationalUnitDimension" - } - } - }, - "description": "The JSON representation of the OperationalUnitDimension resource to be created or updated.", - "required": true, - "x-bodyName": "OperationalUnitDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -125103,7 +155258,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "operationalUnitDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getOperationalUnitDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "operationalUnitDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putOperationalUnitDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension" + } + } + }, + "description": "The JSON representation of the OperationalUnitDimension resource to be created or updated.", + "required": true, + "x-bodyName": "OperationalUnitDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126442,6 +156712,62 @@ "organizationDepartmentId" ], "type": "object" + }, + "EdFi_OrganizationDepartment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OrganizationDepartment_TrackedChangeKey": { + "properties": { + "organizationDepartmentId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "organizationDepartmentId" + ], + "type": "object" + }, + "EdFi_OrganizationDepartment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -126570,7 +156896,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126613,7 +156939,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126633,6 +156959,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/organizationDepartments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOrganizationDepartmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "organizationDepartments" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/organizationDepartments/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOrganizationDepartmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "organizationDepartments" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/organizationDepartments/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -126668,7 +157112,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126700,15 +157144,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -126735,7 +157170,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126792,7 +157227,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127038,6 +157473,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_OtherNameTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OtherNameTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_OtherNameTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -127154,7 +157650,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127197,7 +157693,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127217,6 +157713,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/otherNameTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOtherNameTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "otherNameTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/otherNameTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOtherNameTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "otherNameTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/otherNameTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -127252,7 +157866,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127284,15 +157898,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -127319,7 +157924,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127376,7 +157981,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127601,6 +158206,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ParticipationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ParticipationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ParticipationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -127717,7 +158383,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127760,7 +158426,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127780,27 +158446,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/participationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteParticipationsById", + "/ed-fi/participationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -127814,48 +158493,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "participationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/participationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getParticipationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -127863,14 +158531,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ParticipationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -127882,20 +158550,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "participationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putParticipation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/participationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteParticipationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -127910,18 +158582,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ParticipationDescriptor" - } - } - }, - "description": "The JSON representation of the Participation resource to be created or updated.", - "required": true, - "x-bodyName": "Participation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -127939,7 +158599,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "participationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getParticipationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "participationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putParticipation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor" + } + } + }, + "description": "The JSON representation of the Participation resource to be created or updated.", + "required": true, + "x-bodyName": "Participation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128164,6 +158939,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ParticipationStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ParticipationStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ParticipationStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -128280,7 +159116,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128323,7 +159159,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128343,27 +159179,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/participationStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteParticipationStatusesById", + "/ed-fi/participationStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -128377,48 +159226,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "participationStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/participationStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getParticipationStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -128426,14 +159264,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -128445,20 +159283,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "participationStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putParticipationStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/participationStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteParticipationStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -128473,18 +159315,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor" - } - } - }, - "description": "The JSON representation of the ParticipationStatus resource to be created or updated.", - "required": true, - "x-bodyName": "ParticipationStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -128502,7 +159332,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "participationStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getParticipationStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "participationStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putParticipationStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor" + } + } + }, + "description": "The JSON representation of the ParticipationStatus resource to be created or updated.", + "required": true, + "x-bodyName": "ParticipationStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128716,6 +159661,68 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "EdFi_Person_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Person_TrackedChangeKey": { + "properties": { + "personId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "personId", + "sourceSystemDescriptor" + ], + "type": "object" + }, + "EdFi_Person_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -128797,7 +159804,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128840,7 +159847,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128862,6 +159869,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/people/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPeopleDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "people" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/people/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPeopleKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "people" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/people/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -128897,7 +160026,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128929,15 +160058,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -128964,7 +160084,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129021,7 +160141,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129223,6 +160343,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PerformanceBaseConversionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -129339,7 +160520,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129382,7 +160563,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129402,6 +160583,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/performanceBaseConversionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceBaseConversionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceBaseConversionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/performanceBaseConversionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceBaseConversionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "performanceBaseConversionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/performanceBaseConversionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -129437,7 +160736,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129469,15 +160768,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -129504,7 +160794,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129561,7 +160851,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129786,6 +161076,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PerformanceLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PerformanceLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -129902,7 +161253,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129945,7 +161296,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129965,27 +161316,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/performanceLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePerformanceLevelsById", + "/ed-fi/performanceLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -129999,48 +161363,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "performanceLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/performanceLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPerformanceLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -130048,14 +161401,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -130067,20 +161420,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "performanceLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPerformanceLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/performanceLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePerformanceLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -130095,18 +161452,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor" - } - } - }, - "description": "The JSON representation of the PerformanceLevel resource to be created or updated.", - "required": true, - "x-bodyName": "PerformanceLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -130124,7 +161469,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "performanceLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPerformanceLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "performanceLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPerformanceLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor" + } + } + }, + "description": "The JSON representation of the PerformanceLevel resource to be created or updated.", + "required": true, + "x-bodyName": "PerformanceLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130349,6 +161809,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PersonalInformationVerificationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -130465,7 +161986,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130508,7 +162029,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130528,27 +162049,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/personalInformationVerificationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePersonalInformationVerificationsById", + "/ed-fi/personalInformationVerificationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPersonalInformationVerificationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -130562,48 +162096,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "personalInformationVerificationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/personalInformationVerificationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPersonalInformationVerificationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPersonalInformationVerificationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -130611,14 +162134,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -130630,20 +162153,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "personalInformationVerificationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPersonalInformationVerification", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/personalInformationVerificationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePersonalInformationVerificationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -130658,18 +162185,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor" - } - } - }, - "description": "The JSON representation of the PersonalInformationVerification resource to be created or updated.", - "required": true, - "x-bodyName": "PersonalInformationVerification" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -130687,7 +162202,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "personalInformationVerificationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPersonalInformationVerificationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "personalInformationVerificationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPersonalInformationVerification", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor" + } + } + }, + "description": "The JSON representation of the PersonalInformationVerification resource to be created or updated.", + "required": true, + "x-bodyName": "PersonalInformationVerification" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130912,6 +162542,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PlatformTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PlatformTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PlatformTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -131028,7 +162719,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131071,7 +162762,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131091,27 +162782,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/platformTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePlatformTypesById", + "/ed-fi/platformTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPlatformTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -131125,48 +162829,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "platformTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/platformTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPlatformTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPlatformTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -131174,14 +162867,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -131193,20 +162886,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "platformTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPlatformType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/platformTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePlatformTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -131221,18 +162918,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor" - } - } - }, - "description": "The JSON representation of the PlatformType resource to be created or updated.", - "required": true, - "x-bodyName": "PlatformType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -131250,7 +162935,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "platformTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPlatformTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "platformTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPlatformType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor" + } + } + }, + "description": "The JSON representation of the PlatformType resource to be created or updated.", + "required": true, + "x-bodyName": "PlatformType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131475,6 +163275,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PopulationServedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PopulationServedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PopulationServedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -131591,7 +163452,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131634,7 +163495,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131654,27 +163515,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/populationServedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePopulationServedsById", + "/ed-fi/populationServedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPopulationServedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -131688,48 +163562,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "populationServedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/populationServedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPopulationServedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPopulationServedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -131737,14 +163600,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -131756,20 +163619,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "populationServedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPopulationServed", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/populationServedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePopulationServedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -131784,18 +163651,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor" - } - } - }, - "description": "The JSON representation of the PopulationServed resource to be created or updated.", - "required": true, - "x-bodyName": "PopulationServed" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -131813,7 +163668,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "populationServedDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPopulationServedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "populationServedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPopulationServed", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor" + } + } + }, + "description": "The JSON representation of the PopulationServed resource to be created or updated.", + "required": true, + "x-bodyName": "PopulationServed" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132038,6 +164008,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -132154,7 +164185,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132197,7 +164228,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132217,27 +164248,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/postSecondaryEventCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePostSecondaryEventCategoriesById", + "/ed-fi/postSecondaryEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -132251,48 +164295,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "postSecondaryEventCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postSecondaryEventCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPostSecondaryEventCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -132300,14 +164333,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -132319,20 +164352,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "postSecondaryEventCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPostSecondaryEventCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postSecondaryEventCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePostSecondaryEventCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -132347,18 +164384,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the PostSecondaryEventCategory resource to be created or updated.", - "required": true, - "x-bodyName": "PostSecondaryEventCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -132376,7 +164401,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "postSecondaryEventCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPostSecondaryEventCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "postSecondaryEventCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPostSecondaryEventCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the PostSecondaryEventCategory resource to be created or updated.", + "required": true, + "x-bodyName": "PostSecondaryEventCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132666,6 +164806,73 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_PostSecondaryEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryEvent_TrackedChangeKey": { + "properties": { + "eventDate": { + "format": "date", + "type": "string" + }, + "postSecondaryEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "eventDate", + "postSecondaryEventCategoryDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_PostSecondaryEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -132767,7 +164974,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132810,7 +165017,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132831,27 +165038,40 @@ "Graduation" ] }, - "/ed-fi/postSecondaryEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePostSecondaryEventsById", + "/ed-fi/postSecondaryEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -132865,48 +165085,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "postSecondaryEvents" ] }, + "x-Ed-Fi-domains": [ + "Graduation" + ] + }, + "/ed-fi/postSecondaryEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPostSecondaryEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -132914,14 +165124,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryEvent" + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -132933,20 +165143,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "postSecondaryEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPostSecondaryEvent", + "x-Ed-Fi-domains": [ + "Graduation" + ] + }, + "/ed-fi/postSecondaryEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePostSecondaryEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -132961,18 +165176,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryEvent" - } - } - }, - "description": "The JSON representation of the PostSecondaryEvent resource to be created or updated.", - "required": true, - "x-bodyName": "PostSecondaryEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -132990,7 +165193,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "postSecondaryEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPostSecondaryEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "postSecondaryEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPostSecondaryEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent" + } + } + }, + "description": "The JSON representation of the PostSecondaryEvent resource to be created or updated.", + "required": true, + "x-bodyName": "PostSecondaryEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133204,6 +165522,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -133320,7 +165699,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133363,7 +165742,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133383,27 +165762,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/postSecondaryInstitutionLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePostSecondaryInstitutionLevelsById", + "/ed-fi/postSecondaryInstitutionLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -133417,48 +165809,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "postSecondaryInstitutionLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postSecondaryInstitutionLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPostSecondaryInstitutionLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -133466,14 +165847,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -133485,20 +165866,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "postSecondaryInstitutionLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPostSecondaryInstitutionLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postSecondaryInstitutionLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePostSecondaryInstitutionLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -133513,18 +165898,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor" - } - } - }, - "description": "The JSON representation of the PostSecondaryInstitutionLevel resource to be created or updated.", - "required": true, - "x-bodyName": "PostSecondaryInstitutionLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -133542,7 +165915,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "postSecondaryInstitutionLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPostSecondaryInstitutionLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "postSecondaryInstitutionLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPostSecondaryInstitutionLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor" + } + } + }, + "description": "The JSON representation of the PostSecondaryInstitutionLevel resource to be created or updated.", + "required": true, + "x-bodyName": "PostSecondaryInstitutionLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134943,6 +167431,62 @@ "postSecondaryInstitutionId" ], "type": "object" + }, + "EdFi_PostSecondaryInstitution_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitution_TrackedChangeKey": { + "properties": { + "postSecondaryInstitutionId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "postSecondaryInstitutionId" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitution_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -135070,7 +167614,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135113,7 +167657,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135135,27 +167679,40 @@ "Graduation" ] }, - "/ed-fi/postSecondaryInstitutions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePostSecondaryInstitutionsById", + "/ed-fi/postSecondaryInstitutions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -135169,48 +167726,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "postSecondaryInstitutions" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Graduation" + ] + }, + "/ed-fi/postSecondaryInstitutions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPostSecondaryInstitutionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -135218,14 +167766,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution" + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -135237,20 +167785,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "postSecondaryInstitutions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPostSecondaryInstitution", + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Graduation" + ] + }, + "/ed-fi/postSecondaryInstitutions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePostSecondaryInstitutionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -135265,18 +167819,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution" - } - } - }, - "description": "The JSON representation of the PostSecondaryInstitution resource to be created or updated.", - "required": true, - "x-bodyName": "PostSecondaryInstitution" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -135294,7 +167836,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "postSecondaryInstitutions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPostSecondaryInstitutionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "postSecondaryInstitutions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPostSecondaryInstitution", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution" + } + } + }, + "description": "The JSON representation of the PostSecondaryInstitution resource to be created or updated.", + "required": true, + "x-bodyName": "PostSecondaryInstitution" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135541,6 +168198,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PostingResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostingResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PostingResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -135657,7 +168375,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135700,7 +168418,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135720,27 +168438,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/postingResultDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePostingResultsById", + "/ed-fi/postingResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostingResultsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -135754,48 +168485,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "postingResultDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postingResultDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPostingResultsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostingResultsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -135803,14 +168523,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PostingResultDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -135822,20 +168542,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "postingResultDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPostingResult", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postingResultDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePostingResultsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -135850,18 +168574,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PostingResultDescriptor" - } - } - }, - "description": "The JSON representation of the PostingResult resource to be created or updated.", - "required": true, - "x-bodyName": "PostingResult" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -135879,7 +168591,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "postingResultDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPostingResultsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "postingResultDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPostingResult", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor" + } + } + }, + "description": "The JSON representation of the PostingResult resource to be created or updated.", + "required": true, + "x-bodyName": "PostingResult" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -136104,6 +168931,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -136220,7 +169108,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136263,7 +169151,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -136283,27 +169171,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/primaryLearningDeviceAccessDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePrimaryLearningDeviceAccessesById", + "/ed-fi/primaryLearningDeviceAccessDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAccessesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -136317,48 +169218,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "primaryLearningDeviceAccessDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceAccessDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPrimaryLearningDeviceAccessesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAccessesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -136366,14 +169256,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -136385,20 +169275,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "primaryLearningDeviceAccessDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPrimaryLearningDeviceAccess", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceAccessDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePrimaryLearningDeviceAccessesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -136413,18 +169307,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor" - } - } - }, - "description": "The JSON representation of the PrimaryLearningDeviceAccess resource to be created or updated.", - "required": true, - "x-bodyName": "PrimaryLearningDeviceAccess" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -136442,7 +169324,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "primaryLearningDeviceAccessDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPrimaryLearningDeviceAccessesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "primaryLearningDeviceAccessDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPrimaryLearningDeviceAccess", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor" + } + } + }, + "description": "The JSON representation of the PrimaryLearningDeviceAccess resource to be created or updated.", + "required": true, + "x-bodyName": "PrimaryLearningDeviceAccess" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -136667,6 +169664,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -136783,7 +169841,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136826,7 +169884,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -136846,27 +169904,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePrimaryLearningDeviceAwayFromSchoolsById", + "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAwayFromSchoolsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -136880,48 +169951,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "primaryLearningDeviceAwayFromSchoolDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPrimaryLearningDeviceAwayFromSchoolsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAwayFromSchoolsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -136929,14 +169989,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -136948,20 +170008,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "primaryLearningDeviceAwayFromSchoolDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPrimaryLearningDeviceAwayFromSchool", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePrimaryLearningDeviceAwayFromSchoolsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -136976,18 +170040,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor" - } - } - }, - "description": "The JSON representation of the PrimaryLearningDeviceAwayFromSchool resource to be created or updated.", - "required": true, - "x-bodyName": "PrimaryLearningDeviceAwayFromSchool" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -137005,7 +170057,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "primaryLearningDeviceAwayFromSchoolDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPrimaryLearningDeviceAwayFromSchoolsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "primaryLearningDeviceAwayFromSchoolDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPrimaryLearningDeviceAwayFromSchool", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor" + } + } + }, + "description": "The JSON representation of the PrimaryLearningDeviceAwayFromSchool resource to be created or updated.", + "required": true, + "x-bodyName": "PrimaryLearningDeviceAwayFromSchool" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137230,6 +170397,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -137346,7 +170574,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137389,7 +170617,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137409,27 +170637,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/primaryLearningDeviceProviderDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePrimaryLearningDeviceProvidersById", + "/ed-fi/primaryLearningDeviceProviderDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceProvidersDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -137443,48 +170684,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "primaryLearningDeviceProviderDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceProviderDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPrimaryLearningDeviceProvidersById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceProvidersKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -137492,14 +170722,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -137511,20 +170741,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "primaryLearningDeviceProviderDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPrimaryLearningDeviceProvider", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceProviderDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePrimaryLearningDeviceProvidersById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -137539,18 +170773,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor" - } - } - }, - "description": "The JSON representation of the PrimaryLearningDeviceProvider resource to be created or updated.", - "required": true, - "x-bodyName": "PrimaryLearningDeviceProvider" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -137568,7 +170790,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "primaryLearningDeviceProviderDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPrimaryLearningDeviceProvidersById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "primaryLearningDeviceProviderDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPrimaryLearningDeviceProvider", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor" + } + } + }, + "description": "The JSON representation of the PrimaryLearningDeviceProvider resource to be created or updated.", + "required": true, + "x-bodyName": "PrimaryLearningDeviceProvider" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137793,6 +171130,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProficiencyDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProficiencyDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProficiencyDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -137909,7 +171307,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137952,7 +171350,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137972,27 +171370,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/proficiencyDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProficienciesById", + "/ed-fi/proficiencyDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProficienciesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -138006,48 +171417,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "proficiencyDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/proficiencyDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProficienciesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProficienciesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -138055,14 +171455,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -138074,20 +171474,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "proficiencyDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProficiency", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/proficiencyDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProficienciesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -138102,18 +171506,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor" - } - } - }, - "description": "The JSON representation of the Proficiency resource to be created or updated.", - "required": true, - "x-bodyName": "Proficiency" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -138131,7 +171523,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "proficiencyDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProficienciesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "proficiencyDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProficiency", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor" + } + } + }, + "description": "The JSON representation of the Proficiency resource to be created or updated.", + "required": true, + "x-bodyName": "Proficiency" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138356,6 +171863,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramAssignmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramAssignmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramAssignmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -138472,7 +172040,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138515,7 +172083,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138535,27 +172103,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programAssignmentDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramAssignmentsById", + "/ed-fi/programAssignmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramAssignmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -138569,48 +172150,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programAssignmentDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programAssignmentDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramAssignmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramAssignmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -138618,14 +172188,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -138637,20 +172207,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programAssignmentDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramAssignment", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programAssignmentDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramAssignmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -138665,18 +172239,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramAssignment resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramAssignment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -138694,7 +172256,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programAssignmentDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramAssignmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programAssignmentDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramAssignment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramAssignment resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramAssignment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138919,6 +172596,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -139035,7 +172773,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139078,7 +172816,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139098,27 +172836,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programCharacteristicDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramCharacteristicsById", + "/ed-fi/programCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramCharacteristicsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -139132,48 +172883,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programCharacteristicDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programCharacteristicDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramCharacteristicsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramCharacteristicsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -139181,14 +172921,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -139200,20 +172940,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programCharacteristicDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramCharacteristic", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programCharacteristicDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramCharacteristicsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -139228,18 +172972,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramCharacteristic resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramCharacteristic" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -139257,7 +172989,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programCharacteristicDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramCharacteristicsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programCharacteristicDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramCharacteristic", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramCharacteristic resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramCharacteristic" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139549,6 +173396,68 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ProgramDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "minLength": 1, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ProgramDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -139640,7 +173549,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139683,7 +173592,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139704,27 +173613,40 @@ "Finance" ] }, - "/ed-fi/programDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramDimensionsById", + "/ed-fi/programDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -139738,48 +173660,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/programDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -139787,14 +173699,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramDimension" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -139806,20 +173718,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/programDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -139834,18 +173751,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramDimension" - } - } - }, - "description": "The JSON representation of the ProgramDimension resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -139863,7 +173768,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramDimension" + } + } + }, + "description": "The JSON representation of the ProgramDimension resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -140479,6 +174499,93 @@ "programEvaluationElementTitle" ], "type": "object" + }, + "EdFi_ProgramEvaluationElement_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationElement_TrackedChangeKey": { + "properties": { + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationElementTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "programEducationOrganizationId", + "programEvaluationElementTitle", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationElement_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -140656,7 +174763,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -140699,7 +174806,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -140720,27 +174827,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/programEvaluationElements/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramEvaluationElementsById", + "/ed-fi/programEvaluationElements/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationElementsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -140754,48 +174874,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programEvaluationElements" ] }, + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationElements/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramEvaluationElementsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationElementsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -140803,14 +174913,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -140822,20 +174932,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programEvaluationElements" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramEvaluationElement", + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationElements/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramEvaluationElementsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -140850,18 +174965,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement" - } - } - }, - "description": "The JSON representation of the ProgramEvaluationElement resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramEvaluationElement" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -140879,7 +174982,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programEvaluationElements" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramEvaluationElementsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programEvaluationElements" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramEvaluationElement", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement" + } + } + }, + "description": "The JSON representation of the ProgramEvaluationElement resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramEvaluationElement" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141432,6 +175650,93 @@ "programEvaluationObjectiveTitle" ], "type": "object" + }, + "EdFi_ProgramEvaluationObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationObjective_TrackedChangeKey": { + "properties": { + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationObjectiveTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "programEducationOrganizationId", + "programEvaluationObjectiveTitle", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -141599,7 +175904,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141642,7 +175947,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141663,27 +175968,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/programEvaluationObjectives/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramEvaluationObjectivesById", + "/ed-fi/programEvaluationObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationObjectivesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -141697,48 +176015,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programEvaluationObjectives" ] }, + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationObjectives/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramEvaluationObjectivesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationObjectivesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -141746,14 +176054,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -141765,20 +176073,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programEvaluationObjectives" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramEvaluationObjective", + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationObjectives/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramEvaluationObjectivesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -141793,18 +176106,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective" - } - } - }, - "description": "The JSON representation of the ProgramEvaluationObjective resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramEvaluationObjective" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -141822,7 +176123,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programEvaluationObjectives" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramEvaluationObjectivesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programEvaluationObjectives" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramEvaluationObjective", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective" + } + } + }, + "description": "The JSON representation of the ProgramEvaluationObjective resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramEvaluationObjective" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142088,6 +176504,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -142204,7 +176681,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142247,7 +176724,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142267,27 +176744,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programEvaluationPeriodDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramEvaluationPeriodsById", + "/ed-fi/programEvaluationPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationPeriodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -142301,48 +176791,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programEvaluationPeriodDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programEvaluationPeriodDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramEvaluationPeriodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationPeriodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -142350,14 +176829,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -142369,20 +176848,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programEvaluationPeriodDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramEvaluationPeriod", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programEvaluationPeriodDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramEvaluationPeriodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -142397,18 +176880,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramEvaluationPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramEvaluationPeriod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -142426,7 +176897,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programEvaluationPeriodDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramEvaluationPeriodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programEvaluationPeriodDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramEvaluationPeriod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramEvaluationPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramEvaluationPeriod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142651,6 +177237,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -142767,7 +177414,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142810,7 +177457,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142830,27 +177477,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programEvaluationTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramEvaluationTypesById", + "/ed-fi/programEvaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -142864,48 +177524,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programEvaluationTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programEvaluationTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramEvaluationTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -142913,14 +177562,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -142932,20 +177581,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programEvaluationTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramEvaluationType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programEvaluationTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramEvaluationTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -142960,18 +177613,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramEvaluationType resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramEvaluationType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -142989,7 +177630,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programEvaluationTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramEvaluationTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programEvaluationTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramEvaluationType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramEvaluationType resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramEvaluationType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -143480,6 +178236,88 @@ "programEvaluationTypeDescriptor" ], "type": "object" + }, + "EdFi_ProgramEvaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluation_TrackedChangeKey": { + "properties": { + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "programEducationOrganizationId", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_ProgramEvaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -143628,7 +178466,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143671,7 +178509,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -143692,27 +178530,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/programEvaluations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramEvaluationsById", + "/ed-fi/programEvaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -143726,48 +178577,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programEvaluations" ] }, + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramEvaluationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -143775,14 +178616,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluation" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -143794,20 +178635,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programEvaluations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramEvaluation", + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramEvaluationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -143822,18 +178668,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluation" - } - } - }, - "description": "The JSON representation of the ProgramEvaluation resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramEvaluation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -143851,7 +178685,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programEvaluations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramEvaluationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programEvaluations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramEvaluation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation" + } + } + }, + "description": "The JSON representation of the ProgramEvaluation resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramEvaluation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144104,6 +179053,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramSponsorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramSponsorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramSponsorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -144220,7 +179230,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144263,7 +179273,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144283,27 +179293,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programSponsorDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramSponsorsById", + "/ed-fi/programSponsorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramSponsorsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -144317,48 +179340,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programSponsorDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programSponsorDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramSponsorsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramSponsorsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -144366,14 +179378,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -144385,20 +179397,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programSponsorDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramSponsor", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programSponsorDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramSponsorsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -144413,18 +179429,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramSponsor resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramSponsor" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -144442,7 +179446,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programSponsorDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramSponsorsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programSponsorDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramSponsor", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramSponsor resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramSponsor" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144667,6 +179786,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -144783,7 +179963,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144826,7 +180006,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144846,27 +180026,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramTypesById", + "/ed-fi/programTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -144880,48 +180073,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -144929,14 +180111,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -144948,20 +180130,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -144976,18 +180162,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramType resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -145005,7 +180179,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramType resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145466,6 +180755,73 @@ "programTypeDescriptor" ], "type": "object" + }, + "EdFi_Program_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Program_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_Program_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -145567,7 +180923,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145610,7 +180966,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145641,27 +180997,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/programs/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramsById", + "/ed-fi/programs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -145675,48 +181044,48 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programs" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programs/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -145724,14 +181093,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Program" + "items": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -145743,20 +181112,35 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programs" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgram", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programs/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -145771,18 +181155,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Program" - } - } - }, - "description": "The JSON representation of the Program resource to be created or updated.", - "required": true, - "x-bodyName": "Program" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -145800,7 +181172,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programs" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Program" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programs" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgram", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Program" + } + } + }, + "description": "The JSON representation of the Program resource to be created or updated.", + "required": true, + "x-bodyName": "Program" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146033,6 +181520,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgressDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgressDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgressDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -146149,7 +181697,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146192,7 +181740,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146212,27 +181760,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/progressDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgressesById", + "/ed-fi/progressDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgressesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -146246,48 +181807,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "progressDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/progressDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgressesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgressesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -146295,14 +181845,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgressDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -146314,20 +181864,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "progressDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgress", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/progressDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgressesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -146342,18 +181896,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgressDescriptor" - } - } - }, - "description": "The JSON representation of the Progress resource to be created or updated.", - "required": true, - "x-bodyName": "Progress" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -146371,7 +181913,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "progressDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgressesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "progressDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgress", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor" + } + } + }, + "description": "The JSON representation of the Progress resource to be created or updated.", + "required": true, + "x-bodyName": "Progress" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146596,6 +182253,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgressLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgressLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgressLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -146712,7 +182430,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146755,7 +182473,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146775,27 +182493,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/progressLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgressLevelsById", + "/ed-fi/progressLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgressLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -146809,48 +182540,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "progressLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/progressLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgressLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgressLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -146858,14 +182578,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -146877,20 +182597,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "progressLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgressLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/progressLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgressLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -146905,18 +182629,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor" - } - } - }, - "description": "The JSON representation of the ProgressLevel resource to be created or updated.", - "required": true, - "x-bodyName": "ProgressLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -146934,7 +182646,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "progressLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgressLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "progressLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgressLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor" + } + } + }, + "description": "The JSON representation of the ProgressLevel resource to be created or updated.", + "required": true, + "x-bodyName": "ProgressLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147226,6 +183053,68 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ProjectDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProjectDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "minLength": 1, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ProjectDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -147317,7 +183206,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147360,7 +183249,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147381,27 +183270,40 @@ "Finance" ] }, - "/ed-fi/projectDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProjectDimensionsById", + "/ed-fi/projectDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProjectDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -147415,48 +183317,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "projectDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/projectDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProjectDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProjectDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -147464,14 +183356,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProjectDimension" + "items": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -147483,20 +183375,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "projectDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProjectDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/projectDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProjectDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -147511,18 +183408,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProjectDimension" - } - } - }, - "description": "The JSON representation of the ProjectDimension resource to be created or updated.", - "required": true, - "x-bodyName": "ProjectDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -147540,7 +183425,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "projectDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProjectDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProjectDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "projectDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProjectDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProjectDimension" + } + } + }, + "description": "The JSON representation of the ProjectDimension resource to be created or updated.", + "required": true, + "x-bodyName": "ProjectDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147747,6 +183747,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProviderCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProviderCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProviderCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -147863,7 +183924,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147906,7 +183967,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147926,27 +183987,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/providerCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProviderCategoriesById", + "/ed-fi/providerCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProviderCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -147960,48 +184034,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "providerCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProviderCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProviderCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -148009,14 +184072,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -148028,20 +184091,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "providerCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProviderCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProviderCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -148056,18 +184123,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the ProviderCategory resource to be created or updated.", - "required": true, - "x-bodyName": "ProviderCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -148085,7 +184140,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "providerCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProviderCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "providerCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProviderCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the ProviderCategory resource to be created or updated.", + "required": true, + "x-bodyName": "ProviderCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148310,6 +184480,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProviderProfitabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProviderProfitabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -148426,7 +184657,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148469,7 +184700,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148489,27 +184720,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/providerProfitabilityDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProviderProfitabilitiesById", + "/ed-fi/providerProfitabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProviderProfitabilitiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -148523,48 +184767,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "providerProfitabilityDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerProfitabilityDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProviderProfitabilitiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProviderProfitabilitiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -148572,14 +184805,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -148591,20 +184824,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "providerProfitabilityDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProviderProfitability", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerProfitabilityDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProviderProfitabilitiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -148619,18 +184856,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor" - } - } - }, - "description": "The JSON representation of the ProviderProfitability resource to be created or updated.", - "required": true, - "x-bodyName": "ProviderProfitability" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -148648,7 +184873,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "providerProfitabilityDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProviderProfitabilitiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "providerProfitabilityDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProviderProfitability", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor" + } + } + }, + "description": "The JSON representation of the ProviderProfitability resource to be created or updated.", + "required": true, + "x-bodyName": "ProviderProfitability" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148873,6 +185213,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProviderStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProviderStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProviderStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -148989,7 +185390,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149032,7 +185433,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149052,27 +185453,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/providerStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProviderStatusesById", + "/ed-fi/providerStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProviderStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -149086,48 +185500,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "providerStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProviderStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProviderStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -149135,14 +185538,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -149154,20 +185557,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "providerStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProviderStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProviderStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -149182,18 +185589,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor" - } - } - }, - "description": "The JSON representation of the ProviderStatus resource to be created or updated.", - "required": true, - "x-bodyName": "ProviderStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -149211,7 +185606,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "providerStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProviderStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "providerStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProviderStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor" + } + } + }, + "description": "The JSON representation of the ProviderStatus resource to be created or updated.", + "required": true, + "x-bodyName": "ProviderStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149436,6 +185946,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PublicationStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PublicationStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PublicationStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -149552,7 +186123,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149595,7 +186166,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149615,27 +186186,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/publicationStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePublicationStatusesById", + "/ed-fi/publicationStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPublicationStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -149649,48 +186233,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "publicationStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/publicationStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPublicationStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPublicationStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -149698,14 +186271,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -149717,20 +186290,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "publicationStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPublicationStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/publicationStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePublicationStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -149745,18 +186322,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor" - } - } - }, - "description": "The JSON representation of the PublicationStatus resource to be created or updated.", - "required": true, - "x-bodyName": "PublicationStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -149774,7 +186339,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "publicationStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPublicationStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "publicationStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPublicationStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor" + } + } + }, + "description": "The JSON representation of the PublicationStatus resource to be created or updated.", + "required": true, + "x-bodyName": "PublicationStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149999,6 +186679,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_QuestionFormDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_QuestionFormDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_QuestionFormDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -150115,7 +186856,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150158,7 +186899,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150178,27 +186919,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/questionFormDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteQuestionFormsById", + "/ed-fi/questionFormDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getQuestionFormsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -150212,48 +186966,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "questionFormDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/questionFormDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getQuestionFormsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getQuestionFormsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -150261,14 +187004,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -150280,20 +187023,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "questionFormDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putQuestionForm", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/questionFormDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteQuestionFormsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -150308,18 +187055,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor" - } - } - }, - "description": "The JSON representation of the QuestionForm resource to be created or updated.", - "required": true, - "x-bodyName": "QuestionForm" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -150337,7 +187072,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "questionFormDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getQuestionFormsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "questionFormDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putQuestionForm", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor" + } + } + }, + "description": "The JSON representation of the QuestionForm resource to be created or updated.", + "required": true, + "x-bodyName": "QuestionForm" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150562,6 +187412,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RaceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RaceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RaceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -150678,7 +187589,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150721,7 +187632,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150741,27 +187652,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/raceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRacesById", + "/ed-fi/raceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRacesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -150775,48 +187699,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "raceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/raceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRacesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRacesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -150824,14 +187737,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RaceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -150843,20 +187756,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "raceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRace", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/raceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRacesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -150871,18 +187788,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RaceDescriptor" - } - } - }, - "description": "The JSON representation of the Race resource to be created or updated.", - "required": true, - "x-bodyName": "Race" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -150900,7 +187805,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "raceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRacesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "raceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRace", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor" + } + } + }, + "description": "The JSON representation of the Race resource to be created or updated.", + "required": true, + "x-bodyName": "Race" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151125,6 +188145,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -151241,7 +188322,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151284,7 +188365,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151304,27 +188385,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/ratingLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRatingLevelsById", + "/ed-fi/ratingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRatingLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -151338,48 +188432,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "ratingLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ratingLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRatingLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRatingLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -151387,14 +188470,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -151406,20 +188489,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "ratingLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRatingLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ratingLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRatingLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -151434,18 +188521,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor" - } - } - }, - "description": "The JSON representation of the RatingLevel resource to be created or updated.", - "required": true, - "x-bodyName": "RatingLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -151463,7 +188538,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "ratingLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRatingLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "ratingLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRatingLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor" + } + } + }, + "description": "The JSON representation of the RatingLevel resource to be created or updated.", + "required": true, + "x-bodyName": "RatingLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151688,6 +188878,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReasonExitedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReasonExitedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReasonExitedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -151804,7 +189055,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151847,7 +189098,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151867,27 +189118,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/reasonExitedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteReasonExitedsById", + "/ed-fi/reasonExitedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReasonExitedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -151901,48 +189165,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "reasonExitedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reasonExitedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getReasonExitedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReasonExitedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -151950,14 +189203,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -151969,20 +189222,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "reasonExitedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putReasonExited", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reasonExitedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteReasonExitedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -151997,18 +189254,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor" - } - } - }, - "description": "The JSON representation of the ReasonExited resource to be created or updated.", - "required": true, - "x-bodyName": "ReasonExited" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -152026,7 +189271,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "reasonExitedDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getReasonExitedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "reasonExitedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putReasonExited", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor" + } + } + }, + "description": "The JSON representation of the ReasonExited resource to be created or updated.", + "required": true, + "x-bodyName": "ReasonExited" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152251,6 +189611,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReasonNotTestedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReasonNotTestedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReasonNotTestedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -152367,7 +189788,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152410,7 +189831,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152430,27 +189851,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/reasonNotTestedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteReasonNotTestedsById", + "/ed-fi/reasonNotTestedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReasonNotTestedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -152464,48 +189898,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "reasonNotTestedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reasonNotTestedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getReasonNotTestedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReasonNotTestedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -152513,14 +189936,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -152532,20 +189955,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "reasonNotTestedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putReasonNotTested", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reasonNotTestedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteReasonNotTestedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -152560,18 +189987,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor" - } - } - }, - "description": "The JSON representation of the ReasonNotTested resource to be created or updated.", - "required": true, - "x-bodyName": "ReasonNotTested" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -152589,7 +190004,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "reasonNotTestedDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getReasonNotTestedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "reasonNotTestedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putReasonNotTested", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor" + } + } + }, + "description": "The JSON representation of the ReasonNotTested resource to be created or updated.", + "required": true, + "x-bodyName": "ReasonNotTested" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152814,6 +190344,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RecognitionTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RecognitionTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RecognitionTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -152930,7 +190521,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152973,7 +190564,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152993,27 +190584,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/recognitionTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRecognitionTypesById", + "/ed-fi/recognitionTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRecognitionTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -153027,48 +190631,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "recognitionTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/recognitionTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRecognitionTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRecognitionTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -153076,14 +190669,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -153095,20 +190688,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "recognitionTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRecognitionType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/recognitionTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRecognitionTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -153123,18 +190720,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor" - } - } - }, - "description": "The JSON representation of the RecognitionType resource to be created or updated.", - "required": true, - "x-bodyName": "RecognitionType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -153152,7 +190737,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "recognitionTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRecognitionTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "recognitionTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRecognitionType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor" + } + } + }, + "description": "The JSON representation of the RecognitionType resource to be created or updated.", + "required": true, + "x-bodyName": "RecognitionType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153377,6 +191077,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RelationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RelationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RelationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -153493,7 +191254,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153536,7 +191297,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153556,27 +191317,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/relationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRelationsById", + "/ed-fi/relationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRelationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -153590,48 +191364,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "relationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/relationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRelationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRelationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -153639,14 +191402,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RelationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -153658,20 +191421,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "relationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRelation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/relationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRelationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -153686,18 +191453,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RelationDescriptor" - } - } - }, - "description": "The JSON representation of the Relation resource to be created or updated.", - "required": true, - "x-bodyName": "Relation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -153715,7 +191470,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "relationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRelationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "relationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRelation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor" + } + } + }, + "description": "The JSON representation of the Relation resource to be created or updated.", + "required": true, + "x-bodyName": "Relation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153940,6 +191810,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RepeatIdentifierDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RepeatIdentifierDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RepeatIdentifierDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -154056,7 +191987,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154099,7 +192030,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154119,27 +192050,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/repeatIdentifierDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRepeatIdentifiersById", + "/ed-fi/repeatIdentifierDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRepeatIdentifiersDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -154153,48 +192097,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "repeatIdentifierDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/repeatIdentifierDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRepeatIdentifiersById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRepeatIdentifiersKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -154202,14 +192135,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -154221,20 +192154,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "repeatIdentifierDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRepeatIdentifier", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/repeatIdentifierDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRepeatIdentifiersById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -154249,18 +192186,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor" - } - } - }, - "description": "The JSON representation of the RepeatIdentifier resource to be created or updated.", - "required": true, - "x-bodyName": "RepeatIdentifier" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -154278,7 +192203,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "repeatIdentifierDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRepeatIdentifiersById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "repeatIdentifierDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRepeatIdentifier", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor" + } + } + }, + "description": "The JSON representation of the RepeatIdentifier resource to be created or updated.", + "required": true, + "x-bodyName": "RepeatIdentifier" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -155195,6 +193235,89 @@ "studentCompetencyObjectiveReference" ], "type": "object" + }, + "EdFi_ReportCard_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReportCard_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "gradingPeriodSchoolId": { + "format": "int64", + "type": "integer" + }, + "gradingPeriodSchoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolId", + "gradingPeriodSchoolYear", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_ReportCard_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -155344,7 +193467,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155387,7 +193510,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -155409,27 +193532,40 @@ "ReportCard" ] }, - "/ed-fi/reportCards/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteReportCardsById", + "/ed-fi/reportCards/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReportCardsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -155443,48 +193579,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "reportCards" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/reportCards/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getReportCardsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReportCardsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -155492,14 +193619,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ReportCard" + "items": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -155511,20 +193638,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "reportCards" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putReportCard", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/reportCards/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteReportCardsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -155539,18 +193672,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ReportCard" - } - } - }, - "description": "The JSON representation of the ReportCard resource to be created or updated.", - "required": true, - "x-bodyName": "ReportCard" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -155568,7 +193689,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "reportCards" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getReportCardsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReportCard" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "reportCards" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putReportCard", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReportCard" + } + } + }, + "description": "The JSON representation of the ReportCard resource to be created or updated.", + "required": true, + "x-bodyName": "ReportCard" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -155822,6 +194058,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReporterDescriptionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReporterDescriptionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReporterDescriptionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -155938,7 +194235,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155981,7 +194278,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156001,27 +194298,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/reporterDescriptionDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteReporterDescriptionsById", + "/ed-fi/reporterDescriptionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReporterDescriptionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -156035,48 +194345,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "reporterDescriptionDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reporterDescriptionDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getReporterDescriptionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReporterDescriptionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -156084,14 +194383,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -156103,20 +194402,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "reporterDescriptionDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putReporterDescription", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reporterDescriptionDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteReporterDescriptionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -156131,18 +194434,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor" - } - } - }, - "description": "The JSON representation of the ReporterDescription resource to be created or updated.", - "required": true, - "x-bodyName": "ReporterDescription" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -156160,7 +194451,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "reporterDescriptionDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getReporterDescriptionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "reporterDescriptionDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putReporterDescription", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor" + } + } + }, + "description": "The JSON representation of the ReporterDescription resource to be created or updated.", + "required": true, + "x-bodyName": "ReporterDescription" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156385,6 +194791,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReportingTagDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReportingTagDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReportingTagDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -156501,7 +194968,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156544,7 +195011,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156564,27 +195031,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/reportingTagDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteReportingTagsById", + "/ed-fi/reportingTagDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReportingTagsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -156598,48 +195078,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "reportingTagDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reportingTagDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getReportingTagsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReportingTagsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -156647,14 +195116,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -156666,20 +195135,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "reportingTagDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putReportingTag", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reportingTagDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteReportingTagsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -156694,18 +195167,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor" - } - } - }, - "description": "The JSON representation of the ReportingTag resource to be created or updated.", - "required": true, - "x-bodyName": "ReportingTag" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -156723,7 +195184,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "reportingTagDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getReportingTagsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "reportingTagDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putReportingTag", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor" + } + } + }, + "description": "The JSON representation of the ReportingTag resource to be created or updated.", + "required": true, + "x-bodyName": "ReportingTag" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156948,6 +195524,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResidencyStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResidencyStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResidencyStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -157064,7 +195701,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157107,7 +195744,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157127,27 +195764,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/residencyStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteResidencyStatusesById", + "/ed-fi/residencyStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResidencyStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -157161,48 +195811,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "residencyStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/residencyStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getResidencyStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResidencyStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -157210,14 +195849,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -157229,20 +195868,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "residencyStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putResidencyStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/residencyStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteResidencyStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -157257,18 +195900,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor" - } - } - }, - "description": "The JSON representation of the ResidencyStatus resource to be created or updated.", - "required": true, - "x-bodyName": "ResidencyStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -157286,7 +195917,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "residencyStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getResidencyStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "residencyStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putResidencyStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor" + } + } + }, + "description": "The JSON representation of the ResidencyStatus resource to be created or updated.", + "required": true, + "x-bodyName": "ResidencyStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157511,6 +196257,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResponseIndicatorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResponseIndicatorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResponseIndicatorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -157627,7 +196434,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157670,7 +196477,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157690,27 +196497,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/responseIndicatorDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteResponseIndicatorsById", + "/ed-fi/responseIndicatorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResponseIndicatorsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -157724,48 +196544,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "responseIndicatorDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/responseIndicatorDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getResponseIndicatorsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResponseIndicatorsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -157773,14 +196582,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -157792,20 +196601,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "responseIndicatorDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putResponseIndicator", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/responseIndicatorDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteResponseIndicatorsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -157820,18 +196633,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor" - } - } - }, - "description": "The JSON representation of the ResponseIndicator resource to be created or updated.", - "required": true, - "x-bodyName": "ResponseIndicator" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -157849,7 +196650,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "responseIndicatorDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getResponseIndicatorsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "responseIndicatorDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putResponseIndicator", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor" + } + } + }, + "description": "The JSON representation of the ResponseIndicator resource to be created or updated.", + "required": true, + "x-bodyName": "ResponseIndicator" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158074,6 +196990,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResponsibilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResponsibilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResponsibilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -158190,7 +197167,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158233,7 +197210,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158253,27 +197230,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/responsibilityDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteResponsibilitiesById", + "/ed-fi/responsibilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResponsibilitiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -158287,48 +197277,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "responsibilityDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/responsibilityDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getResponsibilitiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResponsibilitiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -158336,14 +197315,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -158355,20 +197334,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "responsibilityDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putResponsibility", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/responsibilityDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteResponsibilitiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -158383,18 +197366,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor" - } - } - }, - "description": "The JSON representation of the Responsibility resource to be created or updated.", - "required": true, - "x-bodyName": "Responsibility" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -158412,7 +197383,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "responsibilityDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getResponsibilitiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "responsibilityDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putResponsibility", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor" + } + } + }, + "description": "The JSON representation of the Responsibility resource to be created or updated.", + "required": true, + "x-bodyName": "Responsibility" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158637,6 +197723,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RestraintEventReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RestraintEventReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RestraintEventReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -158753,7 +197900,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158796,7 +197943,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158816,27 +197963,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/restraintEventReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRestraintEventReasonsById", + "/ed-fi/restraintEventReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -158850,48 +198010,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "restraintEventReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/restraintEventReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRestraintEventReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -158899,14 +198048,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -158918,20 +198067,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "restraintEventReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRestraintEventReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/restraintEventReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRestraintEventReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -158946,18 +198099,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor" - } - } - }, - "description": "The JSON representation of the RestraintEventReason resource to be created or updated.", - "required": true, - "x-bodyName": "RestraintEventReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -158975,7 +198116,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "restraintEventReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRestraintEventReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "restraintEventReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRestraintEventReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor" + } + } + }, + "description": "The JSON representation of the RestraintEventReason resource to be created or updated.", + "required": true, + "x-bodyName": "RestraintEventReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159430,6 +198686,74 @@ "restraintEventReasonDescriptor" ], "type": "object" + }, + "EdFi_RestraintEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RestraintEvent_TrackedChangeKey": { + "properties": { + "restraintEventIdentifier": { + "maxLength": 36, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "restraintEventIdentifier", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_RestraintEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -159540,7 +198864,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159583,7 +198907,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159604,27 +198928,40 @@ "SpecialEducation" ] }, - "/ed-fi/restraintEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRestraintEventsById", + "/ed-fi/restraintEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -159638,48 +198975,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "restraintEvents" ] }, + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, + "/ed-fi/restraintEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRestraintEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -159687,14 +199014,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RestraintEvent" + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -159706,20 +199033,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "restraintEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRestraintEvent", + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, + "/ed-fi/restraintEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRestraintEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -159734,18 +199066,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RestraintEvent" - } - } - }, - "description": "The JSON representation of the RestraintEvent resource to be created or updated.", - "required": true, - "x-bodyName": "RestraintEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -159763,7 +199083,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "restraintEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRestraintEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RestraintEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "restraintEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRestraintEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RestraintEvent" + } + } + }, + "description": "The JSON representation of the RestraintEvent resource to be created or updated.", + "required": true, + "x-bodyName": "RestraintEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159992,6 +199427,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResultDatatypeTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -160108,7 +199604,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -160151,7 +199647,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -160171,27 +199667,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/resultDatatypeTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteResultDatatypeTypesById", + "/ed-fi/resultDatatypeTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResultDatatypeTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -160205,48 +199714,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "resultDatatypeTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/resultDatatypeTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getResultDatatypeTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResultDatatypeTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -160254,14 +199752,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -160273,20 +199771,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "resultDatatypeTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putResultDatatypeType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/resultDatatypeTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteResultDatatypeTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -160301,18 +199803,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ResultDatatypeType resource to be created or updated.", - "required": true, - "x-bodyName": "ResultDatatypeType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -160330,7 +199820,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "resultDatatypeTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getResultDatatypeTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "resultDatatypeTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putResultDatatypeType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ResultDatatypeType resource to be created or updated.", + "required": true, + "x-bodyName": "ResultDatatypeType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -160555,6 +200160,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RetestIndicatorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RetestIndicatorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RetestIndicatorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -160671,7 +200337,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -160714,7 +200380,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -160734,27 +200400,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/retestIndicatorDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRetestIndicatorsById", + "/ed-fi/retestIndicatorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRetestIndicatorsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -160768,48 +200447,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "retestIndicatorDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/retestIndicatorDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRetestIndicatorsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRetestIndicatorsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -160817,14 +200485,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -160836,20 +200504,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "retestIndicatorDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRetestIndicator", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/retestIndicatorDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRetestIndicatorsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -160864,18 +200536,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor" - } - } - }, - "description": "The JSON representation of the RetestIndicator resource to be created or updated.", - "required": true, - "x-bodyName": "RetestIndicator" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -160893,7 +200553,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "retestIndicatorDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRetestIndicatorsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "retestIndicatorDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRetestIndicator", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor" + } + } + }, + "description": "The JSON representation of the RetestIndicator resource to be created or updated.", + "required": true, + "x-bodyName": "RetestIndicator" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -161118,6 +200893,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -161234,7 +201070,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -161277,7 +201113,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -161297,27 +201133,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/schoolCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSchoolCategoriesById", + "/ed-fi/schoolCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -161331,48 +201180,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "schoolCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSchoolCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -161380,14 +201218,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -161399,20 +201237,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "schoolCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSchoolCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSchoolCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -161427,18 +201269,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the SchoolCategory resource to be created or updated.", - "required": true, - "x-bodyName": "SchoolCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -161456,7 +201286,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "schoolCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSchoolCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "schoolCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSchoolCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the SchoolCategory resource to be created or updated.", + "required": true, + "x-bodyName": "SchoolCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -161681,6 +201626,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolChoiceBasisDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -161797,7 +201803,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -161840,7 +201846,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -161860,27 +201866,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/schoolChoiceBasisDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSchoolChoiceBasesById", + "/ed-fi/schoolChoiceBasisDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceBasesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -161894,48 +201913,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "schoolChoiceBasisDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolChoiceBasisDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSchoolChoiceBasesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceBasesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -161943,14 +201951,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -161962,20 +201970,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "schoolChoiceBasisDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSchoolChoiceBasis", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolChoiceBasisDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSchoolChoiceBasesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -161990,18 +202002,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor" - } - } - }, - "description": "The JSON representation of the SchoolChoiceBasis resource to be created or updated.", - "required": true, - "x-bodyName": "SchoolChoiceBasis" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -162019,7 +202019,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "schoolChoiceBasisDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSchoolChoiceBasesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "schoolChoiceBasisDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSchoolChoiceBasis", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor" + } + } + }, + "description": "The JSON representation of the SchoolChoiceBasis resource to be created or updated.", + "required": true, + "x-bodyName": "SchoolChoiceBasis" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162244,6 +202359,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -162360,7 +202536,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162403,7 +202579,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162423,27 +202599,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/schoolChoiceImplementStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSchoolChoiceImplementStatusesById", + "/ed-fi/schoolChoiceImplementStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceImplementStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -162457,48 +202646,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "schoolChoiceImplementStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolChoiceImplementStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSchoolChoiceImplementStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceImplementStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -162506,14 +202684,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -162525,20 +202703,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "schoolChoiceImplementStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSchoolChoiceImplementStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolChoiceImplementStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSchoolChoiceImplementStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -162553,18 +202735,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor" - } - } - }, - "description": "The JSON representation of the SchoolChoiceImplementStatus resource to be created or updated.", - "required": true, - "x-bodyName": "SchoolChoiceImplementStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -162582,7 +202752,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "schoolChoiceImplementStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSchoolChoiceImplementStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "schoolChoiceImplementStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSchoolChoiceImplementStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor" + } + } + }, + "description": "The JSON representation of the SchoolChoiceImplementStatus resource to be created or updated.", + "required": true, + "x-bodyName": "SchoolChoiceImplementStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162807,6 +203092,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -162923,7 +203269,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162966,7 +203312,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162986,27 +203332,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/schoolFoodServiceProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSchoolFoodServiceProgramServicesById", + "/ed-fi/schoolFoodServiceProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolFoodServiceProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -163020,48 +203379,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "schoolFoodServiceProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolFoodServiceProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSchoolFoodServiceProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolFoodServiceProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -163069,14 +203417,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -163088,20 +203436,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "schoolFoodServiceProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSchoolFoodServiceProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolFoodServiceProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSchoolFoodServiceProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -163116,18 +203468,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the SchoolFoodServiceProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "SchoolFoodServiceProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -163145,7 +203485,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "schoolFoodServiceProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSchoolFoodServiceProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "schoolFoodServiceProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSchoolFoodServiceProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the SchoolFoodServiceProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "SchoolFoodServiceProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163370,6 +203825,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -163486,7 +204002,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163529,7 +204045,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163549,27 +204065,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/schoolTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSchoolTypesById", + "/ed-fi/schoolTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -163583,48 +204112,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "schoolTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSchoolTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -163632,14 +204150,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -163651,20 +204169,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "schoolTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSchoolType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSchoolTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -163679,18 +204201,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor" - } - } - }, - "description": "The JSON representation of the SchoolType resource to be created or updated.", - "required": true, - "x-bodyName": "SchoolType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -163708,7 +204218,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "schoolTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSchoolTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "schoolTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSchoolType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor" + } + } + }, + "description": "The JSON representation of the SchoolType resource to be created or updated.", + "required": true, + "x-bodyName": "SchoolType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163902,6 +204527,62 @@ "schoolYear" ], "type": "object" + }, + "EdFi_SchoolYear_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolYear_TrackedChangeKey": { + "properties": { + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "schoolYear" + ], + "type": "object" + }, + "EdFi_SchoolYear_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -163987,7 +204668,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164030,7 +204711,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164050,6 +204731,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/schoolYearTypes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolYearsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolYearTypes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolYearTypes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolYearsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolYearTypes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/schoolYearTypes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -164085,7 +204884,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164117,15 +204916,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -164152,7 +204942,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164209,7 +204999,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165834,6 +206624,62 @@ "schoolCategoryDescriptor" ], "type": "object" + }, + "EdFi_School_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_School_TrackedChangeKey": { + "properties": { + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "schoolId" + ], + "type": "object" + }, + "EdFi_School_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -166025,7 +206871,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166068,7 +206914,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166102,6 +206948,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/schools/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schools" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/schools/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schools" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/schools/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -166137,7 +207129,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166169,15 +207161,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -166204,7 +207187,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166261,7 +207244,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166778,6 +207761,96 @@ "sectionIdentifier" ], "type": "object" + }, + "EdFi_SectionAttendanceTakenEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SectionAttendanceTakenEvent_TrackedChangeKey": { + "properties": { + "calendarCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "date": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "calendarCode", + "date", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName" + ], + "type": "object" + }, + "EdFi_SectionAttendanceTakenEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -166932,7 +208005,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166975,7 +208048,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166996,27 +208069,40 @@ "StudentAttendance" ] }, - "/ed-fi/sectionAttendanceTakenEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSectionAttendanceTakenEventsById", + "/ed-fi/sectionAttendanceTakenEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionAttendanceTakenEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -167030,48 +208116,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sectionAttendanceTakenEvents" ] }, + "x-Ed-Fi-domains": [ + "StudentAttendance" + ] + }, + "/ed-fi/sectionAttendanceTakenEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSectionAttendanceTakenEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionAttendanceTakenEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -167079,14 +208155,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent" + "items": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -167098,20 +208174,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sectionAttendanceTakenEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSectionAttendanceTakenEvent", + "x-Ed-Fi-domains": [ + "StudentAttendance" + ] + }, + "/ed-fi/sectionAttendanceTakenEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSectionAttendanceTakenEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -167126,18 +208207,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent" - } - } - }, - "description": "The JSON representation of the SectionAttendanceTakenEvent resource to be created or updated.", - "required": true, - "x-bodyName": "SectionAttendanceTakenEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -167155,7 +208224,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sectionAttendanceTakenEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSectionAttendanceTakenEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sectionAttendanceTakenEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSectionAttendanceTakenEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent" + } + } + }, + "description": "The JSON representation of the SectionAttendanceTakenEvent resource to be created or updated.", + "required": true, + "x-bodyName": "SectionAttendanceTakenEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -167406,6 +208590,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SectionCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SectionCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SectionCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -167522,7 +208767,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -167565,7 +208810,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -167585,27 +208830,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/sectionCharacteristicDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSectionCharacteristicsById", + "/ed-fi/sectionCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionCharacteristicsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -167619,48 +208877,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sectionCharacteristicDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sectionCharacteristicDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSectionCharacteristicsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionCharacteristicsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -167668,14 +208915,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -167687,20 +208934,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sectionCharacteristicDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSectionCharacteristic", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sectionCharacteristicDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSectionCharacteristicsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -167715,18 +208966,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor" - } - } - }, - "description": "The JSON representation of the SectionCharacteristic resource to be created or updated.", - "required": true, - "x-bodyName": "SectionCharacteristic" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -167744,7 +208983,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sectionCharacteristicDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSectionCharacteristicsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sectionCharacteristicDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSectionCharacteristic", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor" + } + } + }, + "description": "The JSON representation of the SectionCharacteristic resource to be created or updated.", + "required": true, + "x-bodyName": "SectionCharacteristic" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -167969,6 +209323,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SectionTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SectionTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SectionTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -168085,7 +209500,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -168128,7 +209543,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -168148,27 +209563,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/sectionTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSectionTypesById", + "/ed-fi/sectionTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -168182,48 +209610,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sectionTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sectionTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSectionTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -168231,14 +209648,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -168250,20 +209667,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sectionTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSectionType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sectionTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSectionTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -168278,18 +209699,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor" - } - } - }, - "description": "The JSON representation of the SectionType resource to be created or updated.", - "required": true, - "x-bodyName": "SectionType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -168307,7 +209716,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sectionTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSectionTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sectionTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSectionType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor" + } + } + }, + "description": "The JSON representation of the SectionType resource to be created or updated.", + "required": true, + "x-bodyName": "SectionType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169264,6 +210788,85 @@ "sectionCharacteristicDescriptor" ], "type": "object" + }, + "EdFi_Section_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Section_TrackedChangeKey": { + "properties": { + "localCourseCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName" + ], + "type": "object" + }, + "EdFi_Section_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -169497,7 +211100,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169540,7 +211143,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169572,27 +211175,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/sections/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSectionsById", + "/ed-fi/sections/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -169606,48 +211222,49 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sections" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sections/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSectionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -169655,14 +211272,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Section" + "items": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -169674,20 +211291,36 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sections" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSection", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sections/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSectionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -169702,18 +211335,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Section" - } - } - }, - "description": "The JSON representation of the Section resource to be created or updated.", - "required": true, - "x-bodyName": "Section" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -169731,7 +211352,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sections" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSectionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Section" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sections" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSection", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Section" + } + } + }, + "description": "The JSON representation of the Section resource to be created or updated.", + "required": true, + "x-bodyName": "Section" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -170051,6 +211787,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SeparationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SeparationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SeparationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -170167,7 +211964,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170210,7 +212007,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -170230,27 +212027,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/separationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSeparationsById", + "/ed-fi/separationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -170264,48 +212074,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "separationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/separationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSeparationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -170313,14 +212112,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SeparationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -170332,20 +212131,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "separationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSeparation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/separationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSeparationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -170360,18 +212163,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SeparationDescriptor" - } - } - }, - "description": "The JSON representation of the Separation resource to be created or updated.", - "required": true, - "x-bodyName": "Separation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -170389,7 +212180,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "separationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSeparationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "separationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSeparation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor" + } + } + }, + "description": "The JSON representation of the Separation resource to be created or updated.", + "required": true, + "x-bodyName": "Separation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -170614,6 +212520,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SeparationReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SeparationReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SeparationReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -170730,7 +212697,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170773,7 +212740,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -170793,27 +212760,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/separationReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSeparationReasonsById", + "/ed-fi/separationReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -170827,48 +212807,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "separationReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/separationReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSeparationReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -170876,14 +212845,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -170895,20 +212864,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "separationReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSeparationReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/separationReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSeparationReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -170923,18 +212896,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor" - } - } - }, - "description": "The JSON representation of the SeparationReason resource to be created or updated.", - "required": true, - "x-bodyName": "SeparationReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -170952,7 +212913,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "separationReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSeparationReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "separationReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSeparationReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor" + } + } + }, + "description": "The JSON representation of the SeparationReason resource to be created or updated.", + "required": true, + "x-bodyName": "SeparationReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -171177,6 +213253,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -171293,7 +213430,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -171336,7 +213473,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -171356,27 +213493,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/serviceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteServicesById", + "/ed-fi/serviceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -171390,48 +213540,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "serviceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/serviceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -171439,14 +213578,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -171458,20 +213597,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "serviceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/serviceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -171486,18 +213629,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ServiceDescriptor" - } - } - }, - "description": "The JSON representation of the Service resource to be created or updated.", - "required": true, - "x-bodyName": "Service" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -171515,7 +213646,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "serviceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "serviceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor" + } + } + }, + "description": "The JSON representation of the Service resource to be created or updated.", + "required": true, + "x-bodyName": "Service" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172066,6 +214312,73 @@ "sessionName" ], "type": "object" + }, + "EdFi_Session_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Session_TrackedChangeKey": { + "properties": { + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sessionName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ], + "type": "object" + }, + "EdFi_Session_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -172193,7 +214506,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172236,7 +214549,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172263,27 +214576,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/sessions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSessionsById", + "/ed-fi/sessions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSessionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -172297,48 +214623,44 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sessions" ] }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "SchoolCalendar", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sessions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSessionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSessionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -172346,14 +214668,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Session" + "items": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -172365,20 +214687,31 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sessions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSession", + "x-Ed-Fi-domains": [ + "BellSchedule", + "SchoolCalendar", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sessions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSessionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -172393,18 +214726,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Session" - } - } - }, - "description": "The JSON representation of the Session resource to be created or updated.", - "required": true, - "x-bodyName": "Session" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -172422,7 +214743,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sessions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSessionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Session" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sessions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSession", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Session" + } + } + }, + "description": "The JSON representation of the Session resource to be created or updated.", + "required": true, + "x-bodyName": "Session" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172664,6 +215100,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SexDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SexDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SexDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -172780,7 +215277,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172823,7 +215320,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172843,27 +215340,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/sexDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSexesById", + "/ed-fi/sexDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSexesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -172877,48 +215387,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sexDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sexDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSexesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSexesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -172926,14 +215425,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SexDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -172945,20 +215444,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sexDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSex", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sexDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSexesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -172973,18 +215476,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SexDescriptor" - } - } - }, - "description": "The JSON representation of the Sex resource to be created or updated.", - "required": true, - "x-bodyName": "Sex" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -173002,7 +215493,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sexDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSexesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SexDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sexDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSex", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SexDescriptor" + } + } + }, + "description": "The JSON representation of the Sex resource to be created or updated.", + "required": true, + "x-bodyName": "Sex" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173294,6 +215900,68 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_SourceDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SourceDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "minLength": 1, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_SourceDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -173385,7 +216053,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173428,7 +216096,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173449,27 +216117,40 @@ "Finance" ] }, - "/ed-fi/sourceDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSourceDimensionsById", + "/ed-fi/sourceDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSourceDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -173483,48 +216164,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sourceDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/sourceDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSourceDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSourceDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -173532,14 +216203,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SourceDimension" + "items": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -173551,20 +216222,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sourceDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSourceDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/sourceDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSourceDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -173579,18 +216255,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SourceDimension" - } - } - }, - "description": "The JSON representation of the SourceDimension resource to be created or updated.", - "required": true, - "x-bodyName": "SourceDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -173608,7 +216272,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sourceDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSourceDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SourceDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sourceDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSourceDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SourceDimension" + } + } + }, + "description": "The JSON representation of the SourceDimension resource to be created or updated.", + "required": true, + "x-bodyName": "SourceDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173815,6 +216594,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SourceSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SourceSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SourceSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -173931,7 +216771,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173974,7 +216814,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173994,27 +216834,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/sourceSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSourceSystemsById", + "/ed-fi/sourceSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSourceSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -174028,48 +216881,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sourceSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sourceSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSourceSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSourceSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -174077,14 +216919,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -174096,20 +216938,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sourceSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSourceSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sourceSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSourceSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -174124,18 +216970,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor" - } - } - }, - "description": "The JSON representation of the SourceSystem resource to be created or updated.", - "required": true, - "x-bodyName": "SourceSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -174153,7 +216987,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sourceSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSourceSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sourceSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSourceSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor" + } + } + }, + "description": "The JSON representation of the SourceSystem resource to be created or updated.", + "required": true, + "x-bodyName": "SourceSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -174378,6 +217327,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -174494,7 +217504,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -174537,7 +217547,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -174557,27 +217567,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/specialEducationExitReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSpecialEducationExitReasonsById", + "/ed-fi/specialEducationExitReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationExitReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -174591,48 +217614,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "specialEducationExitReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationExitReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSpecialEducationExitReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationExitReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -174640,14 +217652,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -174659,20 +217671,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "specialEducationExitReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSpecialEducationExitReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationExitReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSpecialEducationExitReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -174687,18 +217703,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor" - } - } - }, - "description": "The JSON representation of the SpecialEducationExitReason resource to be created or updated.", - "required": true, - "x-bodyName": "SpecialEducationExitReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -174716,7 +217720,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "specialEducationExitReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSpecialEducationExitReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "specialEducationExitReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSpecialEducationExitReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor" + } + } + }, + "description": "The JSON representation of the SpecialEducationExitReason resource to be created or updated.", + "required": true, + "x-bodyName": "SpecialEducationExitReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -174941,6 +218060,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -175057,7 +218237,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175100,7 +218280,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -175120,27 +218300,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/specialEducationProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSpecialEducationProgramServicesById", + "/ed-fi/specialEducationProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -175154,48 +218347,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "specialEducationProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSpecialEducationProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -175203,14 +218385,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -175222,20 +218404,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "specialEducationProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSpecialEducationProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSpecialEducationProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -175250,18 +218436,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the SpecialEducationProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "SpecialEducationProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -175279,7 +218453,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "specialEducationProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSpecialEducationProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "specialEducationProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSpecialEducationProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the SpecialEducationProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "SpecialEducationProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -175504,6 +218793,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SpecialEducationSettingDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SpecialEducationSettingDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -175620,7 +218970,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175663,7 +219013,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -175683,27 +219033,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/specialEducationSettingDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSpecialEducationSettingsById", + "/ed-fi/specialEducationSettingDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationSettingsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -175717,48 +219080,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "specialEducationSettingDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationSettingDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSpecialEducationSettingsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationSettingsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -175766,14 +219118,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -175785,20 +219137,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "specialEducationSettingDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSpecialEducationSetting", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationSettingDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSpecialEducationSettingsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -175813,18 +219169,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor" - } - } - }, - "description": "The JSON representation of the SpecialEducationSetting resource to be created or updated.", - "required": true, - "x-bodyName": "SpecialEducationSetting" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -175842,7 +219186,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "specialEducationSettingDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSpecialEducationSettingsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "specialEducationSettingDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSpecialEducationSetting", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor" + } + } + }, + "description": "The JSON representation of the SpecialEducationSetting resource to be created or updated.", + "required": true, + "x-bodyName": "SpecialEducationSetting" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176141,6 +219600,73 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffAbsenceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffAbsenceEvent_TrackedChangeKey": { + "properties": { + "absenceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "absenceEventCategoryDescriptor", + "eventDate", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffAbsenceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -176251,7 +219777,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176294,7 +219820,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176315,27 +219841,40 @@ "Staff" ] }, - "/ed-fi/staffAbsenceEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffAbsenceEventsById", + "/ed-fi/staffAbsenceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffAbsenceEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -176349,48 +219888,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffAbsenceEvents" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffAbsenceEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffAbsenceEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffAbsenceEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -176398,14 +219927,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent" + "items": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -176417,20 +219946,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffAbsenceEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffAbsenceEvent", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffAbsenceEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffAbsenceEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -176445,18 +219979,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent" - } - } - }, - "description": "The JSON representation of the StaffAbsenceEvent resource to be created or updated.", - "required": true, - "x-bodyName": "StaffAbsenceEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -176474,7 +219996,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffAbsenceEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffAbsenceEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffAbsenceEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffAbsenceEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent" + } + } + }, + "description": "The JSON representation of the StaffAbsenceEvent resource to be created or updated.", + "required": true, + "x-bodyName": "StaffAbsenceEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176694,6 +220331,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffClassificationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffClassificationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffClassificationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -176810,7 +220508,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176853,7 +220551,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176873,27 +220571,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/staffClassificationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffClassificationsById", + "/ed-fi/staffClassificationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffClassificationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -176907,48 +220618,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffClassificationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffClassificationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffClassificationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffClassificationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -176956,14 +220656,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -176975,20 +220675,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffClassificationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffClassification", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffClassificationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffClassificationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -177003,18 +220707,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor" - } - } - }, - "description": "The JSON representation of the StaffClassification resource to be created or updated.", - "required": true, - "x-bodyName": "StaffClassification" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -177032,7 +220724,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffClassificationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffClassificationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffClassificationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffClassification", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor" + } + } + }, + "description": "The JSON representation of the StaffClassification resource to be created or updated.", + "required": true, + "x-bodyName": "StaffClassification" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177359,6 +221166,79 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffCohortAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffCohortAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "cohortIdentifier": { + "maxLength": 36, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "cohortIdentifier", + "educationOrganizationId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffCohortAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -177478,7 +221358,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177521,7 +221401,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177542,27 +221422,40 @@ "StudentCohort" ] }, - "/ed-fi/staffCohortAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffCohortAssociationsById", + "/ed-fi/staffCohortAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffCohortAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -177576,48 +221469,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffCohortAssociations" ] }, + "x-Ed-Fi-domains": [ + "StudentCohort" + ] + }, + "/ed-fi/staffCohortAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffCohortAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffCohortAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -177625,14 +221508,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffCohortAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -177644,20 +221527,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffCohortAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffCohortAssociation", + "x-Ed-Fi-domains": [ + "StudentCohort" + ] + }, + "/ed-fi/staffCohortAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffCohortAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -177672,18 +221560,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffCohortAssociation" - } - } - }, - "description": "The JSON representation of the StaffCohortAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffCohortAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -177701,7 +221577,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffCohortAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffCohortAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffCohortAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffCohortAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation" + } + } + }, + "description": "The JSON representation of the StaffCohortAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffCohortAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178024,6 +222015,74 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffDisciplineIncidentAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey": { + "properties": { + "incidentIdentifier": { + "maxLength": 36, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "incidentIdentifier", + "schoolId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -178116,7 +222175,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178159,7 +222218,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178179,27 +222238,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/staffDisciplineIncidentAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffDisciplineIncidentAssociationsById", + "/ed-fi/staffDisciplineIncidentAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDisciplineIncidentAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -178213,48 +222285,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffDisciplineIncidentAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffDisciplineIncidentAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffDisciplineIncidentAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDisciplineIncidentAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -178262,14 +222323,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -178281,20 +222342,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffDisciplineIncidentAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffDisciplineIncidentAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffDisciplineIncidentAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffDisciplineIncidentAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -178309,18 +222374,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation" - } - } - }, - "description": "The JSON representation of the StaffDisciplineIncidentAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffDisciplineIncidentAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -178338,7 +222391,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffDisciplineIncidentAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffDisciplineIncidentAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffDisciplineIncidentAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffDisciplineIncidentAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation" + } + } + }, + "description": "The JSON representation of the StaffDisciplineIncidentAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffDisciplineIncidentAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178826,6 +222994,78 @@ "staffClassificationDescriptor" ], "type": "object" + }, + "EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffClassificationDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "staffClassificationDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -179015,7 +223255,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179058,7 +223298,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179079,27 +223319,40 @@ "Staff" ] }, - "/ed-fi/staffEducationOrganizationAssignmentAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffEducationOrganizationAssignmentAssociationsById", + "/ed-fi/staffEducationOrganizationAssignmentAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationAssignmentAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -179113,48 +223366,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffEducationOrganizationAssignmentAssociations" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationAssignmentAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffEducationOrganizationAssignmentAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationAssignmentAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -179162,14 +223405,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -179181,20 +223424,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffEducationOrganizationAssignmentAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffEducationOrganizationAssignmentAssociation", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationAssignmentAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffEducationOrganizationAssignmentAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -179209,18 +223457,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation" - } - } - }, - "description": "The JSON representation of the StaffEducationOrganizationAssignmentAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffEducationOrganizationAssignmentAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -179238,7 +223474,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffEducationOrganizationAssignmentAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffEducationOrganizationAssignmentAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffEducationOrganizationAssignmentAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffEducationOrganizationAssignmentAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation" + } + } + }, + "description": "The JSON representation of the StaffEducationOrganizationAssignmentAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffEducationOrganizationAssignmentAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180117,6 +224468,74 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKey": { + "properties": { + "contactTitle": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "contactTitle", + "educationOrganizationId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -180228,7 +224647,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180271,7 +224690,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180292,27 +224711,40 @@ "Staff" ] }, - "/ed-fi/staffEducationOrganizationContactAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffEducationOrganizationContactAssociationsById", + "/ed-fi/staffEducationOrganizationContactAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationContactAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -180326,48 +224758,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffEducationOrganizationContactAssociations" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationContactAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffEducationOrganizationContactAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationContactAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -180375,14 +224797,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -180394,20 +224816,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffEducationOrganizationContactAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffEducationOrganizationContactAssociation", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationContactAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffEducationOrganizationContactAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -180422,18 +224849,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation" - } - } - }, - "description": "The JSON representation of the StaffEducationOrganizationContactAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffEducationOrganizationContactAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -180451,7 +224866,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffEducationOrganizationContactAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffEducationOrganizationContactAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffEducationOrganizationContactAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffEducationOrganizationContactAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation" + } + } + }, + "description": "The JSON representation of the StaffEducationOrganizationContactAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffEducationOrganizationContactAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180966,6 +225496,78 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "employmentStatusDescriptor": { + "maxLength": 306, + "type": "string" + }, + "hireDate": { + "format": "date", + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "employmentStatusDescriptor", + "hireDate", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -181161,7 +225763,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181204,7 +225806,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181225,27 +225827,40 @@ "Staff" ] }, - "/ed-fi/staffEducationOrganizationEmploymentAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffEducationOrganizationEmploymentAssociationsById", + "/ed-fi/staffEducationOrganizationEmploymentAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationEmploymentAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -181259,48 +225874,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffEducationOrganizationEmploymentAssociations" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationEmploymentAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffEducationOrganizationEmploymentAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationEmploymentAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -181308,14 +225913,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -181327,20 +225932,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffEducationOrganizationEmploymentAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffEducationOrganizationEmploymentAssociation", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationEmploymentAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffEducationOrganizationEmploymentAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -181355,18 +225965,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation" - } - } - }, - "description": "The JSON representation of the StaffEducationOrganizationEmploymentAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffEducationOrganizationEmploymentAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -181384,7 +225982,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffEducationOrganizationEmploymentAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffEducationOrganizationEmploymentAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffEducationOrganizationEmploymentAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffEducationOrganizationEmploymentAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation" + } + } + }, + "description": "The JSON representation of the StaffEducationOrganizationEmploymentAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffEducationOrganizationEmploymentAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181662,6 +226375,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -181778,7 +226552,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181821,7 +226595,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181841,27 +226615,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/staffIdentificationSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffIdentificationSystemsById", + "/ed-fi/staffIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffIdentificationSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -181875,48 +226662,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffIdentificationSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffIdentificationSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffIdentificationSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffIdentificationSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -181924,14 +226700,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -181943,20 +226719,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffIdentificationSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffIdentificationSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffIdentificationSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffIdentificationSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -181971,18 +226751,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor" - } - } - }, - "description": "The JSON representation of the StaffIdentificationSystem resource to be created or updated.", - "required": true, - "x-bodyName": "StaffIdentificationSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -182000,7 +226768,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffIdentificationSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffIdentificationSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffIdentificationSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffIdentificationSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor" + } + } + }, + "description": "The JSON representation of the StaffIdentificationSystem resource to be created or updated.", + "required": true, + "x-bodyName": "StaffIdentificationSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -182225,6 +227108,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -182341,7 +227285,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182384,7 +227328,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -182404,27 +227348,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/staffLeaveEventCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffLeaveEventCategoriesById", + "/ed-fi/staffLeaveEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeaveEventCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -182438,48 +227395,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffLeaveEventCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffLeaveEventCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffLeaveEventCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeaveEventCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -182487,14 +227433,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -182506,20 +227452,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffLeaveEventCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffLeaveEventCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffLeaveEventCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffLeaveEventCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -182534,18 +227484,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the StaffLeaveEventCategory resource to be created or updated.", - "required": true, - "x-bodyName": "StaffLeaveEventCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -182563,7 +227501,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffLeaveEventCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffLeaveEventCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffLeaveEventCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffLeaveEventCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the StaffLeaveEventCategory resource to be created or updated.", + "required": true, + "x-bodyName": "StaffLeaveEventCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -182875,6 +227928,73 @@ "staffLeaveEventCategoryDescriptor" ], "type": "object" + }, + "EdFi_StaffLeave_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffLeave_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "staffLeaveEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "staffLeaveEventCategoryDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffLeave_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -182993,7 +228113,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183036,7 +228156,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183057,27 +228177,40 @@ "Staff" ] }, - "/ed-fi/staffLeaves/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffLeavesById", + "/ed-fi/staffLeaves/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeavesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -183091,48 +228224,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffLeaves" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffLeaves/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffLeavesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeavesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -183140,14 +228263,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffLeave" + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -183159,20 +228282,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffLeaves" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffLeave", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffLeaves/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffLeavesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -183187,18 +228315,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffLeave" - } - } - }, - "description": "The JSON representation of the StaffLeave resource to be created or updated.", - "required": true, - "x-bodyName": "StaffLeave" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -183216,7 +228332,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffLeaves" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffLeavesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffLeave" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffLeaves" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffLeave", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffLeave" + } + } + }, + "description": "The JSON representation of the StaffLeave resource to be created or updated.", + "required": true, + "x-bodyName": "StaffLeave" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183566,6 +228797,84 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -183695,7 +229004,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183738,7 +229047,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183762,27 +229071,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/staffProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffProgramAssociationsById", + "/ed-fi/staffProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -183796,48 +229118,41 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -183845,14 +229160,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -183864,20 +229179,28 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffProgramAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -183892,18 +229215,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffProgramAssociation" - } - } - }, - "description": "The JSON representation of the StaffProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -183921,7 +229232,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation" + } + } + }, + "description": "The JSON representation of the StaffProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -184422,6 +229848,73 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffSchoolAssociation_TrackedChangeKey": { + "properties": { + "programAssignmentDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "programAssignmentDescriptor", + "schoolId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -184533,7 +230026,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184576,7 +230069,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -184599,27 +230092,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/staffSchoolAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffSchoolAssociationsById", + "/ed-fi/staffSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSchoolAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -184633,48 +230139,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffSchoolAssociations" ] }, + "x-Ed-Fi-domains": [ + "Staff", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffSchoolAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffSchoolAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSchoolAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -184682,14 +230180,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -184701,20 +230199,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffSchoolAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffSchoolAssociation", + "x-Ed-Fi-domains": [ + "Staff", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffSchoolAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffSchoolAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -184729,18 +230234,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation" - } - } - }, - "description": "The JSON representation of the StaffSchoolAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffSchoolAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -184758,7 +230251,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffSchoolAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffSchoolAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffSchoolAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffSchoolAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation" + } + } + }, + "description": "The JSON representation of the StaffSchoolAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffSchoolAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -185218,6 +230826,96 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffSectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffSectionAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffSectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -185395,7 +231093,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -185438,7 +231136,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -185462,27 +231160,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/staffSectionAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffSectionAssociationsById", + "/ed-fi/staffSectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSectionAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -185496,48 +231207,41 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffSectionAssociations" ] }, + "x-Ed-Fi-domains": [ + "SpecialEducation", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffSectionAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffSectionAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSectionAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -185545,14 +231249,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffSectionAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -185564,20 +231268,28 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffSectionAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffSectionAssociation", + "x-Ed-Fi-domains": [ + "SpecialEducation", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffSectionAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffSectionAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -185592,18 +231304,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffSectionAssociation" - } - } - }, - "description": "The JSON representation of the StaffSectionAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffSectionAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -185621,7 +231321,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffSectionAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffSectionAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffSectionAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffSectionAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation" + } + } + }, + "description": "The JSON representation of the StaffSectionAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffSectionAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188437,6 +234252,63 @@ ], "type": "object" }, + "EdFi_Staff_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Staff_TrackedChangeKey": { + "properties": { + "staffUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_Staff_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_Staff_TribalAffiliation": { "properties": { "tribalAffiliationDescriptor": { @@ -188710,7 +234582,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188753,7 +234625,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188783,27 +234655,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/staffs/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffsById", + "/ed-fi/staffs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -188817,48 +234702,47 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffs" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffs/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -188866,14 +234750,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Staff" + "items": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -188885,20 +234769,34 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffs" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaff", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffs/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -188913,18 +234811,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Staff" - } - } - }, - "description": "The JSON representation of the Staff resource to be created or updated.", - "required": true, - "x-bodyName": "Staff" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -188942,7 +234828,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffs" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Staff" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffs" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaff", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Staff" + } + } + }, + "description": "The JSON representation of the Staff resource to be created or updated.", + "required": true, + "x-bodyName": "Staff" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -189276,6 +235277,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StateAbbreviationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StateAbbreviationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StateAbbreviationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -189392,7 +235454,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -189435,7 +235497,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -189455,27 +235517,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/stateAbbreviationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStateAbbreviationsById", + "/ed-fi/stateAbbreviationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStateAbbreviationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -189489,48 +235564,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "stateAbbreviationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/stateAbbreviationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStateAbbreviationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStateAbbreviationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -189538,14 +235602,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -189557,20 +235621,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "stateAbbreviationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStateAbbreviation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/stateAbbreviationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStateAbbreviationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -189585,18 +235653,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor" - } - } - }, - "description": "The JSON representation of the StateAbbreviation resource to be created or updated.", - "required": true, - "x-bodyName": "StateAbbreviation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -189614,7 +235670,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "stateAbbreviationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStateAbbreviationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "stateAbbreviationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStateAbbreviation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor" + } + } + }, + "description": "The JSON representation of the StateAbbreviation resource to be created or updated.", + "required": true, + "x-bodyName": "StateAbbreviation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191080,6 +237251,62 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_StateEducationAgency_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StateEducationAgency_TrackedChangeKey": { + "properties": { + "stateEducationAgencyId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "stateEducationAgencyId" + ], + "type": "object" + }, + "EdFi_StateEducationAgency_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -191189,7 +237416,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191232,7 +237459,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191254,27 +237481,40 @@ "Staff" ] }, - "/ed-fi/stateEducationAgencies/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStateEducationAgenciesById", + "/ed-fi/stateEducationAgencies/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStateEducationAgenciesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -191288,48 +237528,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "stateEducationAgencies" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, + "/ed-fi/stateEducationAgencies/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStateEducationAgenciesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStateEducationAgenciesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -191337,14 +237568,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StateEducationAgency" + "items": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -191356,20 +237587,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "stateEducationAgencies" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStateEducationAgency", + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, + "/ed-fi/stateEducationAgencies/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStateEducationAgenciesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -191384,18 +237621,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StateEducationAgency" - } - } - }, - "description": "The JSON representation of the StateEducationAgency resource to be created or updated.", - "required": true, - "x-bodyName": "StateEducationAgency" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -191413,7 +237638,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "stateEducationAgencies" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStateEducationAgenciesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "stateEducationAgencies" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStateEducationAgency", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency" + } + } + }, + "description": "The JSON representation of the StateEducationAgency resource to be created or updated.", + "required": true, + "x-bodyName": "StateEducationAgency" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -193302,6 +239642,78 @@ "reportCardReference" ], "type": "object" + }, + "EdFi_StudentAcademicRecord_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAcademicRecord_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "schoolYear", + "studentUniqueId", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_StudentAcademicRecord_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -193520,7 +239932,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -193563,7 +239975,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -193586,27 +239998,40 @@ "StudentTranscript" ] }, - "/ed-fi/studentAcademicRecords/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentAcademicRecordsById", + "/ed-fi/studentAcademicRecords/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAcademicRecordsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -193620,48 +240045,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentAcademicRecords" ] }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "StudentTranscript" + ] + }, + "/ed-fi/studentAcademicRecords/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentAcademicRecordsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAcademicRecordsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -193669,14 +240086,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentAcademicRecord" + "items": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -193688,20 +240105,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentAcademicRecords" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentAcademicRecord", + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "StudentTranscript" + ] + }, + "/ed-fi/studentAcademicRecords/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentAcademicRecordsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -193716,18 +240140,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentAcademicRecord" - } - } - }, - "description": "The JSON representation of the StudentAcademicRecord resource to be created or updated.", - "required": true, - "x-bodyName": "StudentAcademicRecord" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -193745,7 +240157,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentAcademicRecords" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentAcademicRecordsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentAcademicRecords" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentAcademicRecord", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord" + } + } + }, + "description": "The JSON representation of the StudentAcademicRecord resource to be created or updated.", + "required": true, + "x-bodyName": "StudentAcademicRecord" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -194189,6 +240716,91 @@ "studentAssessmentIdentifier" ], "type": "object" + }, + "EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "educationOrganizationAssociationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentAssessmentIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "educationOrganizationAssociationTypeDescriptor", + "educationOrganizationId", + "namespace", + "studentAssessmentIdentifier", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -194322,7 +240934,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194365,7 +240977,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -194385,27 +240997,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentAssessmentEducationOrganizationAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentAssessmentEducationOrganizationAssociationsById", + "/ed-fi/studentAssessmentEducationOrganizationAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentEducationOrganizationAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -194419,48 +241044,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentAssessmentEducationOrganizationAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentAssessmentEducationOrganizationAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentAssessmentEducationOrganizationAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentEducationOrganizationAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -194468,14 +241082,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -194487,20 +241101,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentAssessmentEducationOrganizationAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentAssessmentEducationOrganizationAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentAssessmentEducationOrganizationAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentAssessmentEducationOrganizationAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -194515,18 +241133,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation" - } - } - }, - "description": "The JSON representation of the StudentAssessmentEducationOrganizationAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentAssessmentEducationOrganizationAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -194544,7 +241150,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentAssessmentEducationOrganizationAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentAssessmentEducationOrganizationAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentAssessmentEducationOrganizationAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentAssessmentEducationOrganizationAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation" + } + } + }, + "description": "The JSON representation of the StudentAssessmentEducationOrganizationAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentAssessmentEducationOrganizationAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -196075,6 +242796,81 @@ "objectiveAssessmentReference" ], "type": "object" + }, + "EdFi_StudentAssessment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAssessment_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentAssessmentIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "namespace", + "studentAssessmentIdentifier", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentAssessment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -196318,7 +243114,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -196361,7 +243157,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -196383,27 +243179,40 @@ "StudentAssessment" ] }, - "/ed-fi/studentAssessments/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentAssessmentsById", + "/ed-fi/studentAssessments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -196417,48 +243226,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentAssessments" ] }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/studentAssessments/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentAssessmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -196466,14 +243266,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentAssessment" + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -196485,20 +243285,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentAssessments" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentAssessment", + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/studentAssessments/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentAssessmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -196513,18 +243319,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentAssessment" - } - } - }, - "description": "The JSON representation of the StudentAssessment resource to be created or updated.", - "required": true, - "x-bodyName": "StudentAssessment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -196542,7 +243336,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentAssessments" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentAssessmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAssessment" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentAssessments" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentAssessment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAssessment" + } + } + }, + "description": "The JSON representation of the StudentAssessment resource to be created or updated.", + "required": true, + "x-bodyName": "StudentAssessment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -197345,6 +244254,89 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentCteProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCteProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentCteProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -197518,7 +244510,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -197561,7 +244553,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -197581,27 +244573,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentCTEProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentCTEProgramAssociationsById", + "/ed-fi/studentCTEProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCTEProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -197615,48 +244620,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentCTEProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentCTEProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentCTEProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCTEProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -197664,14 +244658,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -197683,20 +244677,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentCTEProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentCTEProgramAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentCTEProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentCTEProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -197711,18 +244709,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentCTEProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentCTEProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -197740,7 +244726,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentCTEProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentCTEProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentCTEProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentCTEProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentCTEProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentCTEProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198013,6 +245114,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StudentCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StudentCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -198129,7 +245291,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198172,7 +245334,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198192,27 +245354,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentCharacteristicDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentCharacteristicsById", + "/ed-fi/studentCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCharacteristicsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -198226,48 +245401,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentCharacteristicDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentCharacteristicDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentCharacteristicsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCharacteristicsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -198275,14 +245439,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -198294,20 +245458,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentCharacteristicDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentCharacteristic", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentCharacteristicDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentCharacteristicsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -198322,18 +245490,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor" - } - } - }, - "description": "The JSON representation of the StudentCharacteristic resource to be created or updated.", - "required": true, - "x-bodyName": "StudentCharacteristic" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -198351,7 +245507,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentCharacteristicDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentCharacteristicsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentCharacteristicDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentCharacteristic", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor" + } + } + }, + "description": "The JSON representation of the StudentCharacteristic resource to be created or updated.", + "required": true, + "x-bodyName": "StudentCharacteristic" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198777,6 +246048,79 @@ "sectionReference" ], "type": "object" + }, + "EdFi_StudentCohortAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCohortAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "cohortIdentifier": { + "maxLength": 36, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "cohortIdentifier", + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentCohortAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -198888,7 +246232,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198931,7 +246275,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198953,27 +246297,40 @@ "StudentCohort" ] }, - "/ed-fi/studentCohortAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentCohortAssociationsById", + "/ed-fi/studentCohortAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCohortAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -198987,48 +246344,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentCohortAssociations" ] }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/studentCohortAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentCohortAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCohortAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -199036,14 +246384,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentCohortAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -199055,20 +246403,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentCohortAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentCohortAssociation", + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/studentCohortAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentCohortAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -199083,18 +246437,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentCohortAssociation" - } - } - }, - "description": "The JSON representation of the StudentCohortAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentCohortAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -199112,7 +246454,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentCohortAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentCohortAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentCohortAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentCohortAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation" + } + } + }, + "description": "The JSON representation of the StudentCohortAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentCohortAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -199799,6 +247256,100 @@ "studentSectionAssociationReference" ], "type": "object" + }, + "EdFi_StudentCompetencyObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCompetencyObjective_TrackedChangeKey": { + "properties": { + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "gradingPeriodSchoolId": { + "format": "int64", + "type": "integer" + }, + "gradingPeriodSchoolYear": { + "format": "int32", + "type": "integer" + }, + "objective": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "objectiveEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "objectiveGradeLevelDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolId", + "gradingPeriodSchoolYear", + "objective", + "objectiveEducationOrganizationId", + "objectiveGradeLevelDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentCompetencyObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -199961,7 +247512,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200004,7 +247555,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200026,27 +247577,40 @@ "ReportCard" ] }, - "/ed-fi/studentCompetencyObjectives/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentCompetencyObjectivesById", + "/ed-fi/studentCompetencyObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCompetencyObjectivesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -200060,48 +247624,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentCompetencyObjectives" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/studentCompetencyObjectives/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentCompetencyObjectivesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCompetencyObjectivesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -200109,14 +247664,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective" + "items": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -200128,20 +247683,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentCompetencyObjectives" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentCompetencyObjective", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/studentCompetencyObjectives/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentCompetencyObjectivesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -200156,18 +247717,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective" - } - } - }, - "description": "The JSON representation of the StudentCompetencyObjective resource to be created or updated.", - "required": true, - "x-bodyName": "StudentCompetencyObjective" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -200185,7 +247734,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentCompetencyObjectives" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentCompetencyObjectivesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentCompetencyObjectives" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentCompetencyObjective", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective" + } + } + }, + "description": "The JSON representation of the StudentCompetencyObjective resource to be created or updated.", + "required": true, + "x-bodyName": "StudentCompetencyObjective" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200588,6 +248252,69 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentContactAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentContactAssociation_TrackedChangeKey": { + "properties": { + "contactUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "contactUniqueId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentContactAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -200730,7 +248457,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200773,7 +248500,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200794,27 +248521,40 @@ "StudentIdentificationAndDemographics" ] }, - "/ed-fi/studentContactAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentContactAssociationsById", + "/ed-fi/studentContactAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentContactAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -200828,48 +248568,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentContactAssociations" ] }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentContactAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentContactAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentContactAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -200877,14 +248607,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentContactAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -200896,20 +248626,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentContactAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentContactAssociation", + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentContactAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentContactAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -200924,18 +248659,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentContactAssociation" - } - } - }, - "description": "The JSON representation of the StudentContactAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentContactAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -200953,7 +248676,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentContactAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentContactAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentContactAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentContactAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation" + } + } + }, + "description": "The JSON representation of the StudentContactAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentContactAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -201340,6 +249178,79 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey": { + "properties": { + "behaviorDescriptor": { + "maxLength": 306, + "type": "string" + }, + "incidentIdentifier": { + "maxLength": 36, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "behaviorDescriptor", + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -201452,7 +249363,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -201495,7 +249406,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -201515,27 +249426,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentDisciplineIncidentBehaviorAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentDisciplineIncidentBehaviorAssociationsById", + "/ed-fi/studentDisciplineIncidentBehaviorAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentBehaviorAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -201549,48 +249473,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentDisciplineIncidentBehaviorAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentDisciplineIncidentBehaviorAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentDisciplineIncidentBehaviorAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentBehaviorAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -201598,14 +249511,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -201617,20 +249530,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentDisciplineIncidentBehaviorAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentDisciplineIncidentBehaviorAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentDisciplineIncidentBehaviorAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentDisciplineIncidentBehaviorAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -201645,18 +249562,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation" - } - } - }, - "description": "The JSON representation of the StudentDisciplineIncidentBehaviorAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentDisciplineIncidentBehaviorAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -201674,7 +249579,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentDisciplineIncidentBehaviorAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentDisciplineIncidentBehaviorAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentDisciplineIncidentBehaviorAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentDisciplineIncidentBehaviorAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation" + } + } + }, + "description": "The JSON representation of the StudentDisciplineIncidentBehaviorAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentDisciplineIncidentBehaviorAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -201988,6 +250008,74 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey": { + "properties": { + "incidentIdentifier": { + "maxLength": 36, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -202080,7 +250168,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -202123,7 +250211,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -202143,27 +250231,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentDisciplineIncidentNonOffenderAssociationsById", + "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentNonOffenderAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -202177,48 +250278,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentDisciplineIncidentNonOffenderAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentDisciplineIncidentNonOffenderAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentNonOffenderAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -202226,14 +250316,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -202245,20 +250335,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentDisciplineIncidentNonOffenderAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentDisciplineIncidentNonOffenderAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentDisciplineIncidentNonOffenderAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -202273,18 +250367,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation" - } - } - }, - "description": "The JSON representation of the StudentDisciplineIncidentNonOffenderAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentDisciplineIncidentNonOffenderAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -202302,7 +250384,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentDisciplineIncidentNonOffenderAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentDisciplineIncidentNonOffenderAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentDisciplineIncidentNonOffenderAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentDisciplineIncidentNonOffenderAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation" + } + } + }, + "description": "The JSON representation of the StudentDisciplineIncidentNonOffenderAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentDisciplineIncidentNonOffenderAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -204648,6 +252845,68 @@ ], "type": "object" }, + "EdFi_StudentEducationOrganizationAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_StudentEducationOrganizationAssociation_TribalAffiliation": { "properties": { "tribalAffiliationDescriptor": { @@ -204867,7 +253126,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204910,7 +253169,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -204932,27 +253191,40 @@ "StudentIdentificationAndDemographics" ] }, - "/ed-fi/studentEducationOrganizationAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentEducationOrganizationAssociationsById", + "/ed-fi/studentEducationOrganizationAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -204966,48 +253238,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentEducationOrganizationAssociations" ] }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentEducationOrganizationAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentEducationOrganizationAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -205015,14 +253278,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -205034,20 +253297,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentEducationOrganizationAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentEducationOrganizationAssociation", + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentEducationOrganizationAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentEducationOrganizationAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -205062,18 +253331,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation" - } - } - }, - "description": "The JSON representation of the StudentEducationOrganizationAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentEducationOrganizationAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -205091,7 +253348,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentEducationOrganizationAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentEducationOrganizationAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentEducationOrganizationAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentEducationOrganizationAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation" + } + } + }, + "description": "The JSON representation of the StudentEducationOrganizationAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentEducationOrganizationAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -205477,6 +253849,78 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "responsibilityDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "responsibilityDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -205587,7 +254031,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205630,7 +254074,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -205651,27 +254095,40 @@ "Enrollment" ] }, - "/ed-fi/studentEducationOrganizationResponsibilityAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentEducationOrganizationResponsibilityAssociationsById", + "/ed-fi/studentEducationOrganizationResponsibilityAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationResponsibilityAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -205685,48 +254142,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentEducationOrganizationResponsibilityAssociations" ] }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/studentEducationOrganizationResponsibilityAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentEducationOrganizationResponsibilityAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationResponsibilityAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -205734,14 +254181,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -205753,20 +254200,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentEducationOrganizationResponsibilityAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentEducationOrganizationResponsibilityAssociation", + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/studentEducationOrganizationResponsibilityAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentEducationOrganizationResponsibilityAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -205781,18 +254233,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation" - } - } - }, - "description": "The JSON representation of the StudentEducationOrganizationResponsibilityAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentEducationOrganizationResponsibilityAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -205810,7 +254250,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentEducationOrganizationResponsibilityAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentEducationOrganizationResponsibilityAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentEducationOrganizationResponsibilityAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentEducationOrganizationResponsibilityAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation" + } + } + }, + "description": "The JSON representation of the StudentEducationOrganizationResponsibilityAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentEducationOrganizationResponsibilityAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206260,6 +254815,75 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentGradebookEntry_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentGradebookEntry_TrackedChangeKey": { + "properties": { + "gradebookEntryIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "gradebookEntryIdentifier", + "namespace", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentGradebookEntry_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -206435,7 +255059,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206478,7 +255102,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206500,27 +255124,40 @@ "Gradebook" ] }, - "/ed-fi/studentGradebookEntries/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentGradebookEntriesById", + "/ed-fi/studentGradebookEntries/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentGradebookEntriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -206534,48 +255171,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentGradebookEntries" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/studentGradebookEntries/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentGradebookEntriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentGradebookEntriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -206583,14 +255211,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentGradebookEntry" + "items": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -206602,20 +255230,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentGradebookEntries" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentGradebookEntry", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/studentGradebookEntries/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentGradebookEntriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -206630,18 +255264,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentGradebookEntry" - } - } - }, - "description": "The JSON representation of the StudentGradebookEntry resource to be created or updated.", - "required": true, - "x-bodyName": "StudentGradebookEntry" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -206659,7 +255281,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentGradebookEntries" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentGradebookEntriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentGradebookEntries" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentGradebookEntry", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry" + } + } + }, + "description": "The JSON representation of the StudentGradebookEntry resource to be created or updated.", + "required": true, + "x-bodyName": "StudentGradebookEntry" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -207388,6 +256125,89 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentHomelessProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentHomelessProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentHomelessProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -207561,7 +256381,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207604,7 +256424,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -207624,27 +256444,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentHomelessProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentHomelessProgramAssociationsById", + "/ed-fi/studentHomelessProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHomelessProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -207658,48 +256491,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentHomelessProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentHomelessProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentHomelessProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHomelessProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -207707,14 +256529,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -207726,20 +256548,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentHomelessProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentHomelessProgramAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentHomelessProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentHomelessProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -207754,18 +256580,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentHomelessProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentHomelessProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -207783,7 +256597,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentHomelessProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentHomelessProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentHomelessProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentHomelessProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentHomelessProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentHomelessProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -208056,6 +256985,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StudentIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -208172,7 +257162,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -208215,7 +257205,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -208235,27 +257225,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentIdentificationSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentIdentificationSystemsById", + "/ed-fi/studentIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIdentificationSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -208269,48 +257272,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentIdentificationSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentIdentificationSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentIdentificationSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIdentificationSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -208318,14 +257310,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -208337,20 +257329,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentIdentificationSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentIdentificationSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentIdentificationSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentIdentificationSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -208365,18 +257361,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor" - } - } - }, - "description": "The JSON representation of the StudentIdentificationSystem resource to be created or updated.", - "required": true, - "x-bodyName": "StudentIdentificationSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -208394,7 +257378,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentIdentificationSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentIdentificationSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentIdentificationSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentIdentificationSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor" + } + } + }, + "description": "The JSON representation of the StudentIdentificationSystem resource to be created or updated.", + "required": true, + "x-bodyName": "StudentIdentificationSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -208885,6 +257984,74 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentInterventionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentInterventionAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionIdentificationCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionIdentificationCode", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentInterventionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -209017,7 +258184,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209060,7 +258227,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209082,27 +258249,40 @@ "StudentCohort" ] }, - "/ed-fi/studentInterventionAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentInterventionAssociationsById", + "/ed-fi/studentInterventionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -209116,48 +258296,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentInterventionAssociations" ] }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/studentInterventionAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentInterventionAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -209165,14 +258336,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -209184,20 +258355,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentInterventionAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentInterventionAssociation", + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/studentInterventionAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentInterventionAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -209212,18 +258389,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation" - } - } - }, - "description": "The JSON representation of the StudentInterventionAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentInterventionAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -209241,7 +258406,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentInterventionAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentInterventionAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentInterventionAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentInterventionAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation" + } + } + }, + "description": "The JSON representation of the StudentInterventionAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentInterventionAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209667,6 +258947,84 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentInterventionAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "interventionIdentificationCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "educationOrganizationId", + "eventDate", + "interventionIdentificationCode", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentInterventionAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -209816,7 +259174,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209859,7 +259217,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209880,27 +259238,40 @@ "Intervention" ] }, - "/ed-fi/studentInterventionAttendanceEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentInterventionAttendanceEventsById", + "/ed-fi/studentInterventionAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAttendanceEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -209914,48 +259285,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentInterventionAttendanceEvents" ] }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/studentInterventionAttendanceEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentInterventionAttendanceEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAttendanceEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -209963,14 +259324,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent" + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -209982,20 +259343,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentInterventionAttendanceEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentInterventionAttendanceEvent", + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/studentInterventionAttendanceEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentInterventionAttendanceEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -210010,18 +259376,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent" - } - } - }, - "description": "The JSON representation of the StudentInterventionAttendanceEvent resource to be created or updated.", - "required": true, - "x-bodyName": "StudentInterventionAttendanceEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -210039,7 +259393,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentInterventionAttendanceEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentInterventionAttendanceEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentInterventionAttendanceEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentInterventionAttendanceEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent" + } + } + }, + "description": "The JSON representation of the StudentInterventionAttendanceEvent resource to be created or updated.", + "required": true, + "x-bodyName": "StudentInterventionAttendanceEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -210886,6 +260355,89 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -211051,7 +260603,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -211094,7 +260646,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -211114,27 +260666,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentLanguageInstructionProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentLanguageInstructionProgramAssociationsById", + "/ed-fi/studentLanguageInstructionProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentLanguageInstructionProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -211148,48 +260713,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentLanguageInstructionProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentLanguageInstructionProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentLanguageInstructionProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentLanguageInstructionProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -211197,14 +260751,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -211216,20 +260770,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentLanguageInstructionProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentLanguageInstructionProgramAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentLanguageInstructionProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentLanguageInstructionProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -211244,18 +260802,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentLanguageInstructionProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentLanguageInstructionProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -211273,7 +260819,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentLanguageInstructionProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentLanguageInstructionProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentLanguageInstructionProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentLanguageInstructionProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentLanguageInstructionProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentLanguageInstructionProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -212123,6 +261784,89 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -212351,7 +262095,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212394,7 +262138,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -212414,27 +262158,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentMigrantEducationProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentMigrantEducationProgramAssociationsById", + "/ed-fi/studentMigrantEducationProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentMigrantEducationProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -212448,48 +262205,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentMigrantEducationProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentMigrantEducationProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentMigrantEducationProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentMigrantEducationProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -212497,14 +262243,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -212516,20 +262262,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentMigrantEducationProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentMigrantEducationProgramAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentMigrantEducationProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentMigrantEducationProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -212544,18 +262294,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentMigrantEducationProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentMigrantEducationProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -212573,7 +262311,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentMigrantEducationProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentMigrantEducationProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentMigrantEducationProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentMigrantEducationProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentMigrantEducationProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentMigrantEducationProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -213355,6 +263208,89 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -213530,7 +263466,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -213573,7 +263509,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -213593,27 +263529,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentNeglectedOrDelinquentProgramAssociationsById", + "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentNeglectedOrDelinquentProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -213627,48 +263576,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentNeglectedOrDelinquentProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentNeglectedOrDelinquentProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentNeglectedOrDelinquentProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -213676,14 +263614,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -213695,20 +263633,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentNeglectedOrDelinquentProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentNeglectedOrDelinquentProgramAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentNeglectedOrDelinquentProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -213723,18 +263665,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentNeglectedOrDelinquentProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentNeglectedOrDelinquentProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -213752,7 +263682,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentNeglectedOrDelinquentProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentNeglectedOrDelinquentProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentNeglectedOrDelinquentProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentNeglectedOrDelinquentProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentNeglectedOrDelinquentProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentNeglectedOrDelinquentProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214025,6 +264070,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StudentParticipationCodeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentParticipationCodeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StudentParticipationCodeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -214141,7 +264247,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214184,7 +264290,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214204,27 +264310,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentParticipationCodeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentParticipationCodesById", + "/ed-fi/studentParticipationCodeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentParticipationCodesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -214238,48 +264357,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentParticipationCodeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentParticipationCodeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentParticipationCodesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentParticipationCodesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -214287,14 +264395,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -214306,20 +264414,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentParticipationCodeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentParticipationCode", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentParticipationCodeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentParticipationCodesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -214334,18 +264446,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor" - } - } - }, - "description": "The JSON representation of the StudentParticipationCode resource to be created or updated.", - "required": true, - "x-bodyName": "StudentParticipationCode" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -214363,7 +264463,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentParticipationCodeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentParticipationCodesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentParticipationCodeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentParticipationCode", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor" + } + } + }, + "description": "The JSON representation of the StudentParticipationCode resource to be created or updated.", + "required": true, + "x-bodyName": "StudentParticipationCode" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -215005,6 +265220,89 @@ "serviceDescriptor" ], "type": "object" + }, + "EdFi_StudentProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -215153,7 +265451,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215196,7 +265494,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -215223,27 +265521,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/studentProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentProgramAssociationsById", + "/ed-fi/studentProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -215257,48 +265568,44 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -215306,14 +265613,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -215325,20 +265632,31 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentProgramAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -215353,18 +265671,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -215382,7 +265688,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -215893,6 +266314,94 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentProgramAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentProgramAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "educationOrganizationId", + "eventDate", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentProgramAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -216062,7 +266571,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -216105,7 +266614,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -216128,27 +266637,40 @@ "StudentAttendance" ] }, - "/ed-fi/studentProgramAttendanceEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentProgramAttendanceEventsById", + "/ed-fi/studentProgramAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAttendanceEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -216162,48 +266684,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentProgramAttendanceEvents" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentProgramAttendanceEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentProgramAttendanceEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAttendanceEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -216211,14 +266725,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent" + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -216230,20 +266744,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentProgramAttendanceEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentProgramAttendanceEvent", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentProgramAttendanceEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentProgramAttendanceEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -216258,18 +266779,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent" - } - } - }, - "description": "The JSON representation of the StudentProgramAttendanceEvent resource to be created or updated.", - "required": true, - "x-bodyName": "StudentProgramAttendanceEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -216287,7 +266796,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentProgramAttendanceEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentProgramAttendanceEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentProgramAttendanceEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentProgramAttendanceEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent" + } + } + }, + "description": "The JSON representation of the StudentProgramAttendanceEvent resource to be created or updated.", + "required": true, + "x-bodyName": "StudentProgramAttendanceEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -217327,6 +267951,99 @@ "programEvaluationObjectiveReference" ], "type": "object" + }, + "EdFi_StudentProgramEvaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentProgramEvaluation_TrackedChangeKey": { + "properties": { + "evaluationDate": { + "format": "date", + "type": "string" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "evaluationDate", + "programEducationOrganizationId", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentProgramEvaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -217527,7 +268244,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217570,7 +268287,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -217591,27 +268308,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/studentProgramEvaluations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentProgramEvaluationsById", + "/ed-fi/studentProgramEvaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramEvaluationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -217625,48 +268355,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentProgramEvaluations" ] }, + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/studentProgramEvaluations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentProgramEvaluationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramEvaluationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -217674,14 +268394,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -217693,20 +268413,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentProgramEvaluations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentProgramEvaluation", + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/studentProgramEvaluations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentProgramEvaluationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -217721,18 +268446,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation" - } - } - }, - "description": "The JSON representation of the StudentProgramEvaluation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentProgramEvaluation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -217750,7 +268463,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentProgramEvaluations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentProgramEvaluationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentProgramEvaluations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentProgramEvaluation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation" + } + } + }, + "description": "The JSON representation of the StudentProgramEvaluation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentProgramEvaluation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -218765,6 +269593,73 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSchoolAssociation_TrackedChangeKey": { + "properties": { + "entryDate": { + "format": "date", + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "entryDate", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -219063,7 +269958,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219106,7 +270001,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -219131,27 +270026,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/studentSchoolAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSchoolAssociationsById", + "/ed-fi/studentSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -219165,48 +270073,42 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSchoolAssociations" ] }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentSchoolAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSchoolAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -219214,14 +270116,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -219233,20 +270135,29 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSchoolAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSchoolAssociation", + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentSchoolAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSchoolAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -219261,18 +270172,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation" - } - } - }, - "description": "The JSON representation of the StudentSchoolAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSchoolAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -219290,7 +270189,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSchoolAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSchoolAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSchoolAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSchoolAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation" + } + } + }, + "description": "The JSON representation of the StudentSchoolAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSchoolAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -219938,6 +270952,89 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSchoolAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sessionName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "eventDate", + "schoolId", + "schoolYear", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSchoolAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -220113,7 +271210,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220156,7 +271253,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -220179,27 +271276,40 @@ "StudentAttendance" ] }, - "/ed-fi/studentSchoolAttendanceEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSchoolAttendanceEventsById", + "/ed-fi/studentSchoolAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAttendanceEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -220213,48 +271323,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSchoolAttendanceEvents" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentSchoolAttendanceEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSchoolAttendanceEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAttendanceEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -220262,14 +271364,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -220281,20 +271383,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSchoolAttendanceEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSchoolAttendanceEvent", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentSchoolAttendanceEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSchoolAttendanceEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -220309,18 +271418,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent" - } - } - }, - "description": "The JSON representation of the StudentSchoolAttendanceEvent resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSchoolAttendanceEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -220338,7 +271435,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSchoolAttendanceEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSchoolAttendanceEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSchoolAttendanceEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSchoolAttendanceEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent" + } + } + }, + "description": "The JSON representation of the StudentSchoolAttendanceEvent resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSchoolAttendanceEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -221037,6 +272249,89 @@ "schoolFoodServiceProgramServiceDescriptor" ], "type": "object" + }, + "EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -221193,7 +272488,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -221236,7 +272531,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -221256,27 +272551,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentSchoolFoodServiceProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSchoolFoodServiceProgramAssociationsById", + "/ed-fi/studentSchoolFoodServiceProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolFoodServiceProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -221290,48 +272598,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSchoolFoodServiceProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentSchoolFoodServiceProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSchoolFoodServiceProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolFoodServiceProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -221339,14 +272636,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -221358,20 +272655,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSchoolFoodServiceProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSchoolFoodServiceProgramAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentSchoolFoodServiceProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSchoolFoodServiceProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -221386,18 +272687,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentSchoolFoodServiceProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSchoolFoodServiceProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -221415,7 +272704,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSchoolFoodServiceProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSchoolFoodServiceProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSchoolFoodServiceProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSchoolFoodServiceProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentSchoolFoodServiceProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSchoolFoodServiceProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -221999,6 +273403,96 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSectionAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -222176,7 +273670,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -222219,7 +273713,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -222248,27 +273742,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/studentSectionAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSectionAssociationsById", + "/ed-fi/studentSectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -222282,48 +273789,46 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSectionAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentSectionAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSectionAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -222331,14 +273836,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSectionAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -222350,20 +273855,33 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSectionAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSectionAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentSectionAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSectionAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -222378,18 +273896,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSectionAssociation" - } - } - }, - "description": "The JSON representation of the StudentSectionAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSectionAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -222407,7 +273913,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSectionAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSectionAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSectionAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSectionAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation" + } + } + }, + "description": "The JSON representation of the StudentSectionAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSectionAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -223051,6 +274672,101 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSectionAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSectionAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "eventDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSectionAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -223248,7 +274964,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223291,7 +275007,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -223314,6 +275030,130 @@ "StudentAttendance" ] }, + "/ed-fi/studentSectionAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAttendanceEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSectionAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentSectionAttendanceEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAttendanceEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSectionAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, "/ed-fi/studentSectionAttendanceEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -223349,7 +275189,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -223381,15 +275221,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -223416,7 +275247,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223473,7 +275304,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -224748,6 +276579,89 @@ "specialEducationProgramServiceDescriptor" ], "type": "object" + }, + "EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -225010,7 +276924,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225053,7 +276967,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225074,6 +276988,126 @@ "SpecialEducation" ] }, + "/ed-fi/studentSpecialEducationProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSpecialEducationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, + "/ed-fi/studentSpecialEducationProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSpecialEducationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, "/ed-fi/studentSpecialEducationProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -225109,7 +277143,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225141,15 +277175,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -225176,7 +277201,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225233,7 +277258,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225984,6 +278009,84 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey": { + "properties": { + "consentToEvaluationReceivedDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "consentToEvaluationReceivedDate", + "educationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -226230,7 +278333,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226273,7 +278376,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -226293,6 +278396,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramEligibilityAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSpecialEducationProgramEligibilityAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramEligibilityAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSpecialEducationProgramEligibilityAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -226328,7 +278549,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -226360,15 +278581,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -226395,7 +278607,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226452,7 +278664,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -227201,6 +279413,89 @@ "titleIPartAProgramServiceDescriptor" ], "type": "object" + }, + "EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -227358,7 +279653,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -227401,7 +279696,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -227421,6 +279716,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/studentTitleIPartAProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTitleIPartAProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentTitleIPartAProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentTitleIPartAProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTitleIPartAProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentTitleIPartAProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/studentTitleIPartAProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -227456,7 +279869,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -227488,15 +279901,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -227523,7 +279927,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -227580,7 +279984,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -228762,6 +281166,63 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_Student_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Student_TrackedChangeKey": { + "properties": { + "studentUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_Student_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -229016,7 +281477,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229059,7 +281520,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229097,6 +281558,160 @@ "StudentTranscript" ] }, + "/ed-fi/students/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "students" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "Enrollment", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/students/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "students" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "Enrollment", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/students/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -229132,7 +281747,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229164,15 +281779,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -229199,7 +281805,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229256,7 +281862,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229591,6 +282197,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SubmissionStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SubmissionStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SubmissionStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -229707,7 +282374,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229750,7 +282417,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229770,6 +282437,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/submissionStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSubmissionStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "submissionStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/submissionStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSubmissionStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "submissionStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/submissionStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -229805,7 +282590,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229837,15 +282622,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -229872,7 +282648,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229929,7 +282705,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230154,6 +282930,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -230270,7 +283107,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230313,7 +283150,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230333,6 +283170,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/supporterMilitaryConnectionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSupporterMilitaryConnectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "supporterMilitaryConnectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/supporterMilitaryConnectionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSupporterMilitaryConnectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "supporterMilitaryConnectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/supporterMilitaryConnectionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -230368,7 +283323,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230400,15 +283355,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -230435,7 +283381,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230492,7 +283438,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230717,6 +283663,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SurveyCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SurveyCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -230833,7 +283840,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230876,7 +283883,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230896,6 +283903,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/surveyCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/surveyCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/surveyCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -230931,7 +284056,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230963,15 +284088,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -230998,7 +284114,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231055,7 +284171,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231339,6 +284455,80 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_SurveyCourseAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyCourseAssociation_TrackedChangeKey": { + "properties": { + "courseCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "courseCode", + "educationOrganizationId", + "namespace", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyCourseAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -231442,7 +284632,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231485,7 +284675,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231506,6 +284696,126 @@ "Survey" ] }, + "/ed-fi/surveyCourseAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCourseAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyCourseAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyCourseAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCourseAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyCourseAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyCourseAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -231541,7 +284851,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231573,15 +284883,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -231608,7 +284909,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231665,7 +284966,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231883,6 +285184,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SurveyLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SurveyLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -231999,7 +285361,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232042,7 +285404,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -232062,6 +285424,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/surveyLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/surveyLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/surveyLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -232097,7 +285577,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -232129,15 +285609,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -232164,7 +285635,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232221,7 +285692,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -232524,6 +285995,85 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_SurveyProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyProgramAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "programName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "namespace", + "programName", + "programTypeDescriptor", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -232637,7 +286187,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232680,7 +286230,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -232701,6 +286251,126 @@ "Survey" ] }, + "/ed-fi/surveyProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -232736,7 +286406,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -232768,15 +286438,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -232803,7 +286464,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232860,7 +286521,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -233467,6 +287128,81 @@ "surveyQuestionResponseValueIdentifier" ], "type": "object" + }, + "EdFi_SurveyQuestionResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyQuestionResponse_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "questionCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "namespace", + "questionCode", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyQuestionResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -233589,7 +287325,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233632,7 +287368,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -233653,6 +287389,126 @@ "Survey" ] }, + "/ed-fi/surveyQuestionResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyQuestionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyQuestionResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyQuestionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyQuestionResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -233688,7 +287544,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -233720,15 +287576,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -233755,7 +287602,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233812,7 +287659,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -234371,6 +288218,75 @@ "sortOrder" ], "type": "object" + }, + "EdFi_SurveyQuestion_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyQuestion_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "questionCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "namespace", + "questionCode", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyQuestion_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -234494,7 +288410,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234537,7 +288453,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -234558,6 +288474,126 @@ "Survey" ] }, + "/ed-fi/surveyQuestions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyQuestions" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyQuestions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyQuestions" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyQuestions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -234593,7 +288629,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -234625,15 +288661,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -234660,7 +288687,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234717,7 +288744,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235003,6 +289030,80 @@ "surveyResponseIdentifier" ], "type": "object" + }, + "EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -235106,7 +289207,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235149,7 +289250,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235170,6 +289271,126 @@ "Survey" ] }, + "/ed-fi/surveyResponseEducationOrganizationTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseEducationOrganizationTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponseEducationOrganizationTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseEducationOrganizationTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponseEducationOrganizationTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -235205,7 +289426,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235237,15 +289458,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -235272,7 +289484,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235329,7 +289541,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235608,6 +289820,81 @@ "surveyResponseIdentifier" ], "type": "object" + }, + "EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "namespace", + "staffUniqueId", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -235712,7 +289999,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235755,7 +290042,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235776,6 +290063,126 @@ "Survey" ] }, + "/ed-fi/surveyResponseStaffTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseStaffTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponseStaffTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseStaffTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponseStaffTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -235811,7 +290218,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235843,15 +290250,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -235878,7 +290276,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235935,7 +290333,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236420,6 +290818,75 @@ "surveyLevelDescriptor" ], "type": "object" + }, + "EdFi_SurveyResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponse_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -236593,7 +291060,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236636,7 +291103,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236657,6 +291124,126 @@ "Survey" ] }, + "/ed-fi/surveyResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -236692,7 +291279,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236724,15 +291311,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -236759,7 +291337,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236816,7 +291394,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237198,6 +291776,97 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_SurveySectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionAssociation_TrackedChangeKey": { + "properties": { + "localCourseCode": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "localCourseCode", + "namespace", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveySectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -237333,7 +292002,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237376,7 +292045,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237397,6 +292066,126 @@ "Survey" ] }, + "/ed-fi/surveySectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -237432,7 +292221,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237464,15 +292253,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -237499,7 +292279,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237556,7 +292336,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237883,6 +292663,86 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -237997,7 +292857,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238040,7 +292900,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238061,6 +292921,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseEducationOrganizationTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseEducationOrganizationTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -238096,7 +293076,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238128,15 +293108,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -238163,7 +293134,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238220,7 +293191,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238537,6 +293508,87 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "namespace", + "staffUniqueId", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -238652,7 +293704,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238695,7 +293747,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238716,6 +293768,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponseStaffTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseStaffTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponseStaffTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseStaffTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponseStaffTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -238751,7 +293923,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238783,15 +293955,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -238818,7 +293981,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238875,7 +294038,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239216,6 +294379,81 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponse_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -239329,7 +294567,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239372,7 +294610,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239393,6 +294631,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -239428,7 +294786,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239460,15 +294818,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -239495,7 +294844,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239552,7 +294901,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239798,6 +295147,75 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySection_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySection_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySection_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -239891,7 +295309,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239934,7 +295352,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239955,6 +295373,126 @@ "Survey" ] }, + "/ed-fi/surveySections/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySections" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySections/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySections" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySections/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -239990,7 +295528,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240022,15 +295560,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -240057,7 +295586,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240114,7 +295643,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240507,6 +296036,69 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_Survey_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Survey_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_Survey_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -240657,7 +296249,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240700,7 +296292,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240721,6 +296313,126 @@ "Survey" ] }, + "/ed-fi/surveys/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveysDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveys" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveys/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveysKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveys" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveys/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -240756,7 +296468,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240788,15 +296500,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -240823,7 +296526,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240880,7 +296583,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241124,6 +296827,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TeachingCredentialBasisDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -241240,7 +297004,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241283,7 +297047,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241303,6 +297067,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/teachingCredentialBasisDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialBasesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "teachingCredentialBasisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/teachingCredentialBasisDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialBasesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "teachingCredentialBasisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/teachingCredentialBasisDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -241338,7 +297220,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241370,15 +297252,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -241405,7 +297278,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241462,7 +297335,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241687,6 +297560,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TeachingCredentialDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TeachingCredentialDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TeachingCredentialDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -241803,7 +297737,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241846,7 +297780,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241866,6 +297800,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/teachingCredentialDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "teachingCredentialDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/teachingCredentialDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "teachingCredentialDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/teachingCredentialDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -241901,7 +297953,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241933,15 +297985,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -241968,7 +298011,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242025,7 +298068,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242250,6 +298293,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -242366,7 +298470,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242409,7 +298513,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242429,6 +298533,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/technicalSkillsAssessmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTechnicalSkillsAssessmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "technicalSkillsAssessmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/technicalSkillsAssessmentDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTechnicalSkillsAssessmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "technicalSkillsAssessmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/technicalSkillsAssessmentDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -242464,7 +298686,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242496,15 +298718,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -242531,7 +298744,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242588,7 +298801,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242813,6 +299026,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TelephoneNumberTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -242929,7 +299203,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242972,7 +299246,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242992,6 +299266,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/telephoneNumberTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTelephoneNumberTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "telephoneNumberTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/telephoneNumberTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTelephoneNumberTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "telephoneNumberTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/telephoneNumberTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -243027,7 +299419,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243059,15 +299451,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -243094,7 +299477,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243151,7 +299534,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243376,6 +299759,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TermDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TermDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TermDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -243492,7 +299936,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243535,7 +299979,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243555,6 +299999,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/termDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTermsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "termDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/termDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTermsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "termDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/termDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -243590,7 +300152,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243622,15 +300184,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -243657,7 +300210,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243714,7 +300267,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243939,6 +300492,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TitleIPartAParticipantDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -244055,7 +300669,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244098,7 +300712,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244118,6 +300732,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/titleIPartAParticipantDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAParticipantsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "titleIPartAParticipantDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/titleIPartAParticipantDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAParticipantsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "titleIPartAParticipantDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/titleIPartAParticipantDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -244153,7 +300885,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244185,15 +300917,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -244220,7 +300943,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244277,7 +301000,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244502,6 +301225,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -244618,7 +301402,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244661,7 +301445,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244681,6 +301465,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/titleIPartAProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "titleIPartAProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/titleIPartAProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "titleIPartAProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/titleIPartAProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -244716,7 +301618,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244748,15 +301650,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -244783,7 +301676,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244840,7 +301733,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245065,6 +301958,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -245181,7 +302135,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245224,7 +302178,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245244,6 +302198,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/titleIPartASchoolDesignationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartASchoolDesignationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "titleIPartASchoolDesignationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/titleIPartASchoolDesignationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartASchoolDesignationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "titleIPartASchoolDesignationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/titleIPartASchoolDesignationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -245279,7 +302351,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245311,15 +302383,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -245346,7 +302409,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245403,7 +302466,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245628,6 +302691,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TribalAffiliationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TribalAffiliationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TribalAffiliationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -245744,7 +302868,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245787,7 +302911,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245807,6 +302931,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/tribalAffiliationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTribalAffiliationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "tribalAffiliationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/tribalAffiliationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTribalAffiliationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "tribalAffiliationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/tribalAffiliationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -245842,7 +303084,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245874,15 +303116,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -245909,7 +303142,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245966,7 +303199,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246191,6 +303424,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_VisaDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_VisaDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_VisaDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -246307,7 +303601,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246350,7 +303644,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246370,6 +303664,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/visaDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getVisasDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "visaDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/visaDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getVisasKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "visaDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/visaDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -246405,7 +303817,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246437,15 +303849,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -246472,7 +303875,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246529,7 +303932,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246754,6 +304157,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_WeaponDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_WeaponDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_WeaponDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -246870,7 +304334,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246913,7 +304377,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246933,6 +304397,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/weaponDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getWeaponsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "weaponDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/weaponDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getWeaponsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "weaponDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/weaponDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -246968,7 +304550,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247000,15 +304582,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -247035,7 +304608,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247092,7 +304665,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" diff --git a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_2/ds-5.1-api-schema-authoritative.json b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_2/ds-5.1-api-schema-authoritative.json index da0276902..45936f173 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_2/ds-5.1-api-schema-authoritative.json +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_2/ds-5.1-api-schema-authoritative.json @@ -966,6 +966,66 @@ ], "isExtensionProject": false, "openApiBaseDocuments": { + "changeQueries": { + "components": { + "parameters": { + }, + "responses": { + }, + "schemas": { + } + }, + "info": { + "contact": { + "url": "https://www.ed-fi.org/what-is-ed-fi/contact/" + }, + "description": "The Ed-Fi DMS API enables applications to read and write education data stored in an Ed-Fi DMS through a secure REST interface. \n***\n > *Note: Consumers of DMS information should sanitize all data for display and storage. DMS provides reasonable safeguards against cross-site scripting attacks and other malicious content, but the platform does not and cannot guarantee that the data it contains is free of all potentially harmful content.* \n***\n", + "title": "Ed-Fi Data Management Service API", + "version": "1" + }, + "openapi": "3.0.0", + "paths": { + "/availableChangeVersions": { + "get": { + "operationId": "getAvailableChangeVersions", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "newestChangeVersion": { + "format": "int64", + "type": "integer" + }, + "oldestChangeVersion": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "oldestChangeVersion", + "newestChangeVersion" + ], + "type": "object" + } + } + }, + "description": "The available change version range was successfully retrieved." + } + }, + "summary": "Retrieves the available change version range." + } + } + }, + "servers": [ + { + "url": "" + } + ], + "tags": [ + ] + }, "descriptors": { "components": { "parameters": { @@ -991,6 +1051,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1000,6 +1061,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1114,9 +1176,6 @@ "NotFound": { "description": "The resource could not be found." }, - "NotFoundUseSnapshot": { - "description": "The resource could not be found. If Use-Snapshot header is set to true, this response can indicate the snapshot may have been removed." - }, "NotModified": { "description": "The resource's current server-side ETag value matched the If-None-Match header value supplied with the request indicating the resource has not been modified." }, @@ -1177,6 +1236,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1186,6 +1246,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1300,9 +1361,6 @@ "NotFound": { "description": "The resource could not be found." }, - "NotFoundUseSnapshot": { - "description": "The resource could not be found. If Use-Snapshot header is set to true, this response can indicate the snapshot may have been removed." - }, "NotModified": { "description": "The resource's current server-side ETag value matched the If-None-Match header value supplied with the request indicating the resource has not been modified." }, @@ -1838,6 +1896,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AbsenceEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -1954,7 +2073,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1997,7 +2116,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2017,6 +2136,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/absenceEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAbsenceEventCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "absenceEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/absenceEventCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAbsenceEventCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "absenceEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/absenceEventCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -2052,7 +2289,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2084,15 +2321,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -2119,7 +2347,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2176,7 +2404,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2401,6 +2629,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AcademicHonorCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -2517,7 +2806,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2560,7 +2849,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2580,27 +2869,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/academicHonorCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAcademicHonorCategoriesById", + "/ed-fi/academicHonorCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicHonorCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2614,48 +2916,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "academicHonorCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/academicHonorCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAcademicHonorCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicHonorCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -2663,14 +2954,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2682,20 +2973,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "academicHonorCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAcademicHonorCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/academicHonorCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAcademicHonorCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -2710,18 +3005,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AcademicHonorCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AcademicHonorCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -2739,7 +3022,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "academicHonorCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAcademicHonorCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "academicHonorCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAcademicHonorCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AcademicHonorCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AcademicHonorCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2964,6 +3362,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AcademicSubjectDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AcademicSubjectDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AcademicSubjectDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3080,7 +3539,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3123,7 +3582,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3143,27 +3602,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/academicSubjectDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAcademicSubjectsById", + "/ed-fi/academicSubjectDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicSubjectsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3177,48 +3649,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "academicSubjectDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/academicSubjectDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAcademicSubjectsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicSubjectsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -3226,14 +3687,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3245,20 +3706,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "academicSubjectDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAcademicSubject", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/academicSubjectDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAcademicSubjectsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -3273,18 +3738,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" - } - } - }, - "description": "The JSON representation of the AcademicSubject resource to be created or updated.", - "required": true, - "x-bodyName": "AcademicSubject" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -3302,7 +3755,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "academicSubjectDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAcademicSubjectsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "academicSubjectDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAcademicSubject", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" + } + } + }, + "description": "The JSON representation of the AcademicSubject resource to be created or updated.", + "required": true, + "x-bodyName": "AcademicSubject" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3590,6 +4158,68 @@ "weekIdentifier" ], "type": "object" + }, + "EdFi_AcademicWeek_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AcademicWeek_TrackedChangeKey": { + "properties": { + "schoolId": { + "format": "int64", + "type": "integer" + }, + "weekIdentifier": { + "maxLength": 80, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "schoolId", + "weekIdentifier" + ], + "type": "object" + }, + "EdFi_AcademicWeek_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3698,7 +4328,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3741,7 +4371,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3762,27 +4392,40 @@ "SchoolCalendar" ] }, - "/ed-fi/academicWeeks/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAcademicWeeksById", + "/ed-fi/academicWeeks/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicWeeksDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3796,48 +4439,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "academicWeeks" ] }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/academicWeeks/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAcademicWeeksById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicWeeksKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -3845,14 +4478,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AcademicWeek" + "items": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3864,20 +4497,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "academicWeeks" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAcademicWeek", + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/academicWeeks/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAcademicWeeksById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -3892,18 +4530,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AcademicWeek" - } - } - }, - "description": "The JSON representation of the AcademicWeek resource to be created or updated.", - "required": true, - "x-bodyName": "AcademicWeek" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -3921,7 +4547,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "academicWeeks" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAcademicWeeksById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicWeek" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "academicWeeks" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAcademicWeek", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicWeek" + } + } + }, + "description": "The JSON representation of the AcademicWeek resource to be created or updated.", + "required": true, + "x-bodyName": "AcademicWeek" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4144,6 +4885,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AccommodationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccommodationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AccommodationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -4260,7 +5062,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4303,7 +5105,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4323,27 +5125,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/accommodationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAccommodationsById", + "/ed-fi/accommodationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccommodationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4357,48 +5172,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "accommodationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/accommodationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAccommodationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccommodationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -4406,14 +5210,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AccommodationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4425,20 +5229,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "accommodationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAccommodation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/accommodationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAccommodationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -4453,18 +5261,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AccommodationDescriptor" - } - } - }, - "description": "The JSON representation of the Accommodation resource to be created or updated.", - "required": true, - "x-bodyName": "Accommodation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -4482,7 +5278,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "accommodationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAccommodationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "accommodationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAccommodation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor" + } + } + }, + "description": "The JSON representation of the Accommodation resource to be created or updated.", + "required": true, + "x-bodyName": "Accommodation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4707,6 +5618,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AccountTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccountTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AccountTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -4823,7 +5795,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4866,7 +5838,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4886,27 +5858,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/accountTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAccountTypesById", + "/ed-fi/accountTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccountTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4920,48 +5905,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "accountTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/accountTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAccountTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccountTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -4969,14 +5943,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4988,20 +5962,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "accountTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAccountType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/accountTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAccountTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -5016,18 +5994,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor" - } - } - }, - "description": "The JSON representation of the AccountType resource to be created or updated.", - "required": true, - "x-bodyName": "AccountType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -5045,7 +6011,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "accountTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAccountTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "accountTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAccountType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor" + } + } + }, + "description": "The JSON representation of the AccountType resource to be created or updated.", + "required": true, + "x-bodyName": "AccountType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5391,6 +6472,72 @@ "schoolYear" ], "type": "object" + }, + "EdFi_AccountabilityRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccountabilityRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "ratingTitle": { + "maxLength": 60, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "educationOrganizationId", + "ratingTitle", + "schoolYear" + ], + "type": "object" + }, + "EdFi_AccountabilityRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -5517,7 +6664,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5560,7 +6707,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5582,27 +6729,40 @@ "Enrollment" ] }, - "/ed-fi/accountabilityRatings/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAccountabilityRatingsById", + "/ed-fi/accountabilityRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccountabilityRatingsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -5616,48 +6776,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "accountabilityRatings" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment" + ] + }, + "/ed-fi/accountabilityRatings/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAccountabilityRatingsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccountabilityRatingsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -5665,14 +6816,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AccountabilityRating" + "items": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -5684,20 +6835,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "accountabilityRatings" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAccountabilityRating", + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment" + ] + }, + "/ed-fi/accountabilityRatings/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAccountabilityRatingsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -5712,18 +6869,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AccountabilityRating" - } - } - }, - "description": "The JSON representation of the AccountabilityRating resource to be created or updated.", - "required": true, - "x-bodyName": "AccountabilityRating" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -5741,7 +6886,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "accountabilityRatings" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAccountabilityRatingsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "accountabilityRatings" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAccountabilityRating", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating" + } + } + }, + "description": "The JSON representation of the AccountabilityRating resource to be created or updated.", + "required": true, + "x-bodyName": "AccountabilityRating" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5977,6 +7237,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AchievementCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AchievementCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AchievementCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -6093,7 +7414,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6136,7 +7457,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6156,27 +7477,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/achievementCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAchievementCategoriesById", + "/ed-fi/achievementCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAchievementCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6190,48 +7524,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "achievementCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/achievementCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAchievementCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAchievementCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -6239,14 +7562,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6258,20 +7581,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "achievementCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAchievementCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/achievementCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAchievementCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -6286,18 +7613,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AchievementCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AchievementCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -6315,7 +7630,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "achievementCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAchievementCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "achievementCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAchievementCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AchievementCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AchievementCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6540,6 +7970,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AdditionalCreditTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -6656,7 +8147,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6699,7 +8190,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6719,27 +8210,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/additionalCreditTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAdditionalCreditTypesById", + "/ed-fi/additionalCreditTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAdditionalCreditTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6753,48 +8257,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "additionalCreditTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/additionalCreditTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAdditionalCreditTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAdditionalCreditTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -6802,14 +8295,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6821,20 +8314,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "additionalCreditTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAdditionalCreditType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/additionalCreditTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAdditionalCreditTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -6849,18 +8346,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor" - } - } - }, - "description": "The JSON representation of the AdditionalCreditType resource to be created or updated.", - "required": true, - "x-bodyName": "AdditionalCreditType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -6878,7 +8363,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "additionalCreditTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAdditionalCreditTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "additionalCreditTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAdditionalCreditType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor" + } + } + }, + "description": "The JSON representation of the AdditionalCreditType resource to be created or updated.", + "required": true, + "x-bodyName": "AdditionalCreditType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7103,6 +8703,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AddressTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AddressTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AddressTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -7219,7 +8880,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7262,7 +8923,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7282,27 +8943,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/addressTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAddressTypesById", + "/ed-fi/addressTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAddressTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7316,48 +8990,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "addressTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/addressTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAddressTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAddressTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -7365,14 +9028,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7384,20 +9047,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "addressTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAddressType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/addressTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAddressTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -7412,18 +9079,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor" - } - } - }, - "description": "The JSON representation of the AddressType resource to be created or updated.", - "required": true, - "x-bodyName": "AddressType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -7441,7 +9096,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "addressTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAddressTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "addressTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAddressType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor" + } + } + }, + "description": "The JSON representation of the AddressType resource to be created or updated.", + "required": true, + "x-bodyName": "AddressType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7666,6 +9436,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AdministrationEnvironmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -7782,7 +9613,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7825,7 +9656,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7845,27 +9676,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/administrationEnvironmentDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAdministrationEnvironmentsById", + "/ed-fi/administrationEnvironmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrationEnvironmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7879,48 +9723,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "administrationEnvironmentDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/administrationEnvironmentDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAdministrationEnvironmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrationEnvironmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -7928,14 +9761,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7947,20 +9780,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "administrationEnvironmentDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAdministrationEnvironment", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/administrationEnvironmentDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAdministrationEnvironmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -7975,18 +9812,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor" - } - } - }, - "description": "The JSON representation of the AdministrationEnvironment resource to be created or updated.", - "required": true, - "x-bodyName": "AdministrationEnvironment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -8004,7 +9829,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "administrationEnvironmentDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAdministrationEnvironmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "administrationEnvironmentDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAdministrationEnvironment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor" + } + } + }, + "description": "The JSON representation of the AdministrationEnvironment resource to be created or updated.", + "required": true, + "x-bodyName": "AdministrationEnvironment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8229,6 +10169,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AdministrativeFundingControlDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -8345,7 +10346,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8388,7 +10389,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8408,27 +10409,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/administrativeFundingControlDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAdministrativeFundingControlsById", + "/ed-fi/administrativeFundingControlDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrativeFundingControlsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -8442,48 +10456,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "administrativeFundingControlDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/administrativeFundingControlDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAdministrativeFundingControlsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrativeFundingControlsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -8491,14 +10494,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -8510,20 +10513,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "administrativeFundingControlDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAdministrativeFundingControl", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/administrativeFundingControlDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAdministrativeFundingControlsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -8538,18 +10545,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor" - } - } - }, - "description": "The JSON representation of the AdministrativeFundingControl resource to be created or updated.", - "required": true, - "x-bodyName": "AdministrativeFundingControl" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -8567,7 +10562,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "administrativeFundingControlDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAdministrativeFundingControlsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "administrativeFundingControlDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAdministrativeFundingControl", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor" + } + } + }, + "description": "The JSON representation of the AdministrativeFundingControl resource to be created or updated.", + "required": true, + "x-bodyName": "AdministrativeFundingControl" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8792,6 +10902,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AncestryEthnicOriginDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -8908,7 +11079,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8951,7 +11122,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8971,27 +11142,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/ancestryEthnicOriginDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAncestryEthnicOriginsById", + "/ed-fi/ancestryEthnicOriginDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAncestryEthnicOriginsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -9005,48 +11189,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "ancestryEthnicOriginDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ancestryEthnicOriginDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAncestryEthnicOriginsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAncestryEthnicOriginsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -9054,14 +11227,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -9073,20 +11246,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "ancestryEthnicOriginDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAncestryEthnicOrigin", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ancestryEthnicOriginDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAncestryEthnicOriginsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -9101,18 +11278,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor" - } - } - }, - "description": "The JSON representation of the AncestryEthnicOrigin resource to be created or updated.", - "required": true, - "x-bodyName": "AncestryEthnicOrigin" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -9130,7 +11295,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "ancestryEthnicOriginDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAncestryEthnicOriginsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "ancestryEthnicOriginDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAncestryEthnicOrigin", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor" + } + } + }, + "description": "The JSON representation of the AncestryEthnicOrigin resource to be created or updated.", + "required": true, + "x-bodyName": "AncestryEthnicOrigin" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9355,6 +11635,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -9471,7 +11812,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9514,7 +11855,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9534,27 +11875,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentCategoriesById", + "/ed-fi/assessmentCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -9568,48 +11922,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -9617,14 +11960,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -9636,20 +11979,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -9664,18 +12011,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -9693,7 +12028,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9918,6 +12368,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -10034,7 +12545,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10077,7 +12588,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10097,27 +12608,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentIdentificationSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentIdentificationSystemsById", + "/ed-fi/assessmentIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentIdentificationSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -10131,48 +12655,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentIdentificationSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentIdentificationSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentIdentificationSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentIdentificationSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -10180,14 +12693,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -10199,20 +12712,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentIdentificationSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentIdentificationSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentIdentificationSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentIdentificationSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -10227,18 +12744,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentIdentificationSystem resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentIdentificationSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -10256,7 +12761,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentIdentificationSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentIdentificationSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentIdentificationSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentIdentificationSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentIdentificationSystem resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentIdentificationSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10481,6 +13101,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentItemCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -10597,7 +13278,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10640,7 +13321,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10660,27 +13341,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentItemCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentItemCategoriesById", + "/ed-fi/assessmentItemCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -10694,48 +13388,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentItemCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentItemCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentItemCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -10743,14 +13426,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -10762,20 +13445,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentItemCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentItemCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentItemCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentItemCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -10790,18 +13477,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentItemCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentItemCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -10819,7 +13494,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentItemCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentItemCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentItemCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentItemCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentItemCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentItemCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -11044,6 +13834,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentItemResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentItemResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentItemResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -11160,7 +14011,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -11203,7 +14054,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -11223,27 +14074,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentItemResultDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentItemResultsById", + "/ed-fi/assessmentItemResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemResultsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -11257,48 +14121,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentItemResultDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentItemResultDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentItemResultsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemResultsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -11306,14 +14159,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -11325,20 +14178,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentItemResultDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentItemResult", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentItemResultDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentItemResultsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -11353,18 +14210,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentItemResult resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentItemResult" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -11382,7 +14227,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentItemResultDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentItemResultsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentItemResultDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentItemResult", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentItemResult resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentItemResult" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -11897,6 +14857,73 @@ "identificationCode" ], "type": "object" + }, + "EdFi_AssessmentItem_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentItem_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "identificationCode": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "identificationCode", + "namespace" + ], + "type": "object" + }, + "EdFi_AssessmentItem_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -12043,7 +15070,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -12086,7 +15113,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -12108,27 +15135,40 @@ "AssessmentMetadata" ] }, - "/ed-fi/assessmentItems/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentItemsById", + "/ed-fi/assessmentItems/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -12142,48 +15182,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentItems" ] }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessmentItems/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentItemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -12191,14 +15222,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItem" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -12210,20 +15241,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentItems" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentItem", + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessmentItems/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentItemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -12238,18 +15275,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItem" - } - } - }, - "description": "The JSON representation of the AssessmentItem resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentItem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -12267,7 +15292,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentItems" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentItemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItem" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentItems" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentItem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItem" + } + } + }, + "description": "The JSON representation of the AssessmentItem resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentItem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -12512,6 +15652,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -12628,7 +15829,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -12671,7 +15872,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -12691,27 +15892,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentPeriodDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentPeriodsById", + "/ed-fi/assessmentPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentPeriodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -12725,48 +15939,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentPeriodDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentPeriodDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentPeriodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentPeriodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -12774,14 +15977,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -12793,20 +15996,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentPeriodDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentPeriod", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentPeriodDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentPeriodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -12821,18 +16028,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentPeriod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -12850,7 +16045,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentPeriodDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentPeriodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentPeriodDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentPeriod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentPeriod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -13075,6 +16385,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentReportingMethodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -13191,7 +16562,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -13234,7 +16605,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -13254,27 +16625,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentReportingMethodDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentReportingMethodsById", + "/ed-fi/assessmentReportingMethodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentReportingMethodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -13288,48 +16672,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentReportingMethodDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentReportingMethodDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentReportingMethodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentReportingMethodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -13337,14 +16710,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -13356,20 +16729,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentReportingMethodDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentReportingMethod", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentReportingMethodDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentReportingMethodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -13384,18 +16761,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentReportingMethod resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentReportingMethod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -13413,7 +16778,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentReportingMethodDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentReportingMethodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentReportingMethodDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentReportingMethod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentReportingMethod resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentReportingMethod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -13850,6 +17330,73 @@ "scoreRangeId" ], "type": "object" + }, + "EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "scoreRangeId": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "namespace", + "scoreRangeId" + ], + "type": "object" + }, + "EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -13978,7 +17525,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14021,7 +17568,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14041,27 +17588,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentScoreRangeLearningStandards/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentScoreRangeLearningStandardsById", + "/ed-fi/assessmentScoreRangeLearningStandards/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentScoreRangeLearningStandardsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -14075,48 +17635,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentScoreRangeLearningStandards" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentScoreRangeLearningStandards/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentScoreRangeLearningStandardsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentScoreRangeLearningStandardsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -14124,14 +17673,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -14143,20 +17692,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentScoreRangeLearningStandards" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentScoreRangeLearningStandard", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentScoreRangeLearningStandards/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentScoreRangeLearningStandardsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -14171,18 +17724,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard" - } - } - }, - "description": "The JSON representation of the AssessmentScoreRangeLearningStandard resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentScoreRangeLearningStandard" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -14200,7 +17741,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentScoreRangeLearningStandards" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentScoreRangeLearningStandardsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentScoreRangeLearningStandards" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentScoreRangeLearningStandard", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard" + } + } + }, + "description": "The JSON representation of the AssessmentScoreRangeLearningStandard resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentScoreRangeLearningStandard" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15741,6 +19397,68 @@ "sectionReference" ], "type": "object" + }, + "EdFi_Assessment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Assessment_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_Assessment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -15912,7 +19630,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15955,7 +19673,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15977,27 +19695,40 @@ "AssessmentMetadata" ] }, - "/ed-fi/assessments/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentsById", + "/ed-fi/assessments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -16011,48 +19742,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessments" ] }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessments/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -16060,14 +19782,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Assessment" + "items": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -16079,20 +19801,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessments" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessment", + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessments/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -16107,18 +19835,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Assessment" - } - } - }, - "description": "The JSON representation of the Assessment resource to be created or updated.", - "required": true, - "x-bodyName": "Assessment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -16136,7 +19852,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessments" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Assessment" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessments" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Assessment" + } + } + }, + "description": "The JSON representation of the Assessment resource to be created or updated.", + "required": true, + "x-bodyName": "Assessment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16408,6 +20239,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssignmentLateStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssignmentLateStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -16524,7 +20416,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16567,7 +20459,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16587,27 +20479,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assignmentLateStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssignmentLateStatusesById", + "/ed-fi/assignmentLateStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssignmentLateStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -16621,48 +20526,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assignmentLateStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assignmentLateStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssignmentLateStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssignmentLateStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -16670,14 +20564,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -16689,20 +20583,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assignmentLateStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssignmentLateStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assignmentLateStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssignmentLateStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -16717,18 +20615,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor" - } - } - }, - "description": "The JSON representation of the AssignmentLateStatus resource to be created or updated.", - "required": true, - "x-bodyName": "AssignmentLateStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -16746,7 +20632,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assignmentLateStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssignmentLateStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assignmentLateStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssignmentLateStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor" + } + } + }, + "description": "The JSON representation of the AssignmentLateStatus resource to be created or updated.", + "required": true, + "x-bodyName": "AssignmentLateStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16971,6 +20972,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AttemptStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AttemptStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AttemptStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -17087,7 +21149,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17130,7 +21192,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17150,27 +21212,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/attemptStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAttemptStatusesById", + "/ed-fi/attemptStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAttemptStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -17184,48 +21259,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "attemptStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/attemptStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAttemptStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAttemptStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -17233,14 +21297,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -17252,20 +21316,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "attemptStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAttemptStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/attemptStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAttemptStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -17280,18 +21348,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor" - } - } - }, - "description": "The JSON representation of the AttemptStatus resource to be created or updated.", - "required": true, - "x-bodyName": "AttemptStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -17309,7 +21365,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "attemptStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAttemptStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "attemptStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAttemptStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor" + } + } + }, + "description": "The JSON representation of the AttemptStatus resource to be created or updated.", + "required": true, + "x-bodyName": "AttemptStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17534,6 +21705,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AttendanceEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -17650,7 +21882,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17693,7 +21925,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17713,27 +21945,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/attendanceEventCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAttendanceEventCategoriesById", + "/ed-fi/attendanceEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAttendanceEventCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -17747,48 +21992,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "attendanceEventCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/attendanceEventCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAttendanceEventCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAttendanceEventCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -17796,14 +22030,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -17815,20 +22049,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "attendanceEventCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAttendanceEventCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/attendanceEventCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAttendanceEventCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -17843,18 +22081,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AttendanceEventCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AttendanceEventCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -17872,7 +22098,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "attendanceEventCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAttendanceEventCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "attendanceEventCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAttendanceEventCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AttendanceEventCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AttendanceEventCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18159,6 +22500,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_BalanceSheetDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BalanceSheetDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_BalanceSheetDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -18248,7 +22650,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18291,7 +22693,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18312,27 +22714,40 @@ "Finance" ] }, - "/ed-fi/balanceSheetDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteBalanceSheetDimensionsById", + "/ed-fi/balanceSheetDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBalanceSheetDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -18346,48 +22761,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "balanceSheetDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/balanceSheetDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getBalanceSheetDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBalanceSheetDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -18395,14 +22800,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_BalanceSheetDimension" + "items": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -18414,20 +22819,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "balanceSheetDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putBalanceSheetDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/balanceSheetDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteBalanceSheetDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -18442,18 +22852,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_BalanceSheetDimension" - } - } - }, - "description": "The JSON representation of the BalanceSheetDimension resource to be created or updated.", - "required": true, - "x-bodyName": "BalanceSheetDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -18471,7 +22869,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "balanceSheetDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getBalanceSheetDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "balanceSheetDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putBalanceSheetDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension" + } + } + }, + "description": "The JSON representation of the BalanceSheetDimension resource to be created or updated.", + "required": true, + "x-bodyName": "BalanceSheetDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18678,6 +23191,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -18794,7 +23368,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18837,7 +23411,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18857,27 +23431,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/barrierToInternetAccessInResidenceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteBarrierToInternetAccessInResidencesById", + "/ed-fi/barrierToInternetAccessInResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBarrierToInternetAccessInResidencesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -18891,48 +23478,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "barrierToInternetAccessInResidenceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/barrierToInternetAccessInResidenceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getBarrierToInternetAccessInResidencesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBarrierToInternetAccessInResidencesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -18940,14 +23516,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -18959,20 +23535,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "barrierToInternetAccessInResidenceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putBarrierToInternetAccessInResidence", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/barrierToInternetAccessInResidenceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteBarrierToInternetAccessInResidencesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -18987,18 +23567,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor" - } - } - }, - "description": "The JSON representation of the BarrierToInternetAccessInResidence resource to be created or updated.", - "required": true, - "x-bodyName": "BarrierToInternetAccessInResidence" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -19016,7 +23584,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "barrierToInternetAccessInResidenceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getBarrierToInternetAccessInResidencesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "barrierToInternetAccessInResidenceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putBarrierToInternetAccessInResidence", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor" + } + } + }, + "description": "The JSON representation of the BarrierToInternetAccessInResidence resource to be created or updated.", + "required": true, + "x-bodyName": "BarrierToInternetAccessInResidence" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19241,6 +23924,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BehaviorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BehaviorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BehaviorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -19357,7 +24101,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19400,7 +24144,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19420,27 +24164,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/behaviorDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteBehaviorsById", + "/ed-fi/behaviorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBehaviorsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -19454,48 +24211,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "behaviorDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/behaviorDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getBehaviorsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBehaviorsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -19503,14 +24249,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_BehaviorDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -19522,20 +24268,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "behaviorDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putBehavior", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/behaviorDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteBehaviorsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -19550,18 +24300,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_BehaviorDescriptor" - } - } - }, - "description": "The JSON representation of the Behavior resource to be created or updated.", - "required": true, - "x-bodyName": "Behavior" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -19579,7 +24317,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "behaviorDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getBehaviorsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "behaviorDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putBehavior", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor" + } + } + }, + "description": "The JSON representation of the Behavior resource to be created or updated.", + "required": true, + "x-bodyName": "Behavior" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20064,6 +24917,67 @@ "schoolId" ], "type": "object" + }, + "EdFi_BellSchedule_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BellSchedule_TrackedChangeKey": { + "properties": { + "bellScheduleName": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "bellScheduleName", + "schoolId" + ], + "type": "object" + }, + "EdFi_BellSchedule_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -20178,7 +25092,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20221,7 +25135,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20242,27 +25156,40 @@ "BellSchedule" ] }, - "/ed-fi/bellSchedules/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteBellSchedulesById", + "/ed-fi/bellSchedules/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBellSchedulesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20276,48 +25203,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "bellSchedules" ] }, + "x-Ed-Fi-domains": [ + "BellSchedule" + ] + }, + "/ed-fi/bellSchedules/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getBellSchedulesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBellSchedulesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -20325,14 +25242,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_BellSchedule" + "items": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20344,20 +25261,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "bellSchedules" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putBellSchedule", + "x-Ed-Fi-domains": [ + "BellSchedule" + ] + }, + "/ed-fi/bellSchedules/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteBellSchedulesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -20372,18 +25294,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_BellSchedule" - } - } - }, - "description": "The JSON representation of the BellSchedule resource to be created or updated.", - "required": true, - "x-bodyName": "BellSchedule" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -20401,7 +25311,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "bellSchedules" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getBellSchedulesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BellSchedule" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "bellSchedules" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putBellSchedule", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BellSchedule" + } + } + }, + "description": "The JSON representation of the BellSchedule resource to be created or updated.", + "required": true, + "x-bodyName": "BellSchedule" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20630,6 +25655,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BusRouteDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BusRouteDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BusRouteDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -20746,7 +25832,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20789,7 +25875,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20809,27 +25895,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/busRouteDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteBusRoutesById", + "/ed-fi/busRouteDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBusRoutesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20843,48 +25942,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "busRouteDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/busRouteDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getBusRoutesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBusRoutesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -20892,14 +25980,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_BusRouteDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20911,20 +25999,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "busRouteDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putBusRoute", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/busRouteDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteBusRoutesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -20939,18 +26031,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_BusRouteDescriptor" - } - } - }, - "description": "The JSON representation of the BusRoute resource to be created or updated.", - "required": true, - "x-bodyName": "BusRoute" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -20968,7 +26048,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "busRouteDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getBusRoutesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "busRouteDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putBusRoute", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor" + } + } + }, + "description": "The JSON representation of the BusRoute resource to be created or updated.", + "required": true, + "x-bodyName": "BusRoute" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21291,6 +26486,77 @@ "date" ], "type": "object" + }, + "EdFi_CalendarDate_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CalendarDate_TrackedChangeKey": { + "properties": { + "calendarCode": { + "maxLength": 60, + "type": "string" + }, + "date": { + "format": "date", + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "calendarCode", + "date", + "schoolId", + "schoolYear" + ], + "type": "object" + }, + "EdFi_CalendarDate_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -21391,7 +26657,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21434,7 +26700,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21455,27 +26721,40 @@ "SchoolCalendar" ] }, - "/ed-fi/calendarDates/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCalendarDatesById", + "/ed-fi/calendarDates/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarDatesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -21489,48 +26768,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "calendarDates" ] }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendarDates/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCalendarDatesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarDatesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -21538,14 +26807,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CalendarDate" + "items": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -21557,20 +26826,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "calendarDates" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCalendarDate", + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendarDates/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCalendarDatesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -21585,18 +26859,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CalendarDate" - } - } - }, - "description": "The JSON representation of the CalendarDate resource to be created or updated.", - "required": true, - "x-bodyName": "CalendarDate" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -21614,7 +26876,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "calendarDates" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCalendarDatesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarDate" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "calendarDates" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCalendarDate", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarDate" + } + } + }, + "description": "The JSON representation of the CalendarDate resource to be created or updated.", + "required": true, + "x-bodyName": "CalendarDate" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21831,6 +27208,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CalendarEventDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CalendarEventDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CalendarEventDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -21947,7 +27385,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21990,7 +27428,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22010,27 +27448,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/calendarEventDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCalendarEventsById", + "/ed-fi/calendarEventDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -22044,48 +27495,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "calendarEventDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/calendarEventDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCalendarEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -22093,14 +27533,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -22112,20 +27552,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "calendarEventDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCalendarEvent", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/calendarEventDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCalendarEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -22140,18 +27584,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor" - } - } - }, - "description": "The JSON representation of the CalendarEvent resource to be created or updated.", - "required": true, - "x-bodyName": "CalendarEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -22169,7 +27601,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "calendarEventDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCalendarEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "calendarEventDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCalendarEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor" + } + } + }, + "description": "The JSON representation of the CalendarEvent resource to be created or updated.", + "required": true, + "x-bodyName": "CalendarEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22394,6 +27941,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CalendarTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CalendarTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CalendarTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -22510,7 +28118,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22553,7 +28161,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22573,27 +28181,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/calendarTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCalendarTypesById", + "/ed-fi/calendarTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -22607,48 +28228,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "calendarTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/calendarTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCalendarTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -22656,14 +28266,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -22675,20 +28285,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "calendarTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCalendarType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/calendarTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCalendarTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -22703,18 +28317,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CalendarType resource to be created or updated.", - "required": true, - "x-bodyName": "CalendarType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -22732,7 +28334,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "calendarTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCalendarTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "calendarTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCalendarType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CalendarType resource to be created or updated.", + "required": true, + "x-bodyName": "CalendarType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23079,6 +28796,72 @@ "schoolYear" ], "type": "object" + }, + "EdFi_Calendar_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Calendar_TrackedChangeKey": { + "properties": { + "calendarCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "calendarCode", + "schoolId", + "schoolYear" + ], + "type": "object" + }, + "EdFi_Calendar_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -23178,7 +28961,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23221,7 +29004,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23242,27 +29025,40 @@ "SchoolCalendar" ] }, - "/ed-fi/calendars/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCalendarsById", + "/ed-fi/calendars/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -23276,48 +29072,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "calendars" ] }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendars/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCalendarsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -23325,14 +29111,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Calendar" + "items": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -23344,20 +29130,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "calendars" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCalendar", + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendars/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCalendarsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -23372,18 +29163,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Calendar" - } - } - }, - "description": "The JSON representation of the Calendar resource to be created or updated.", - "required": true, - "x-bodyName": "Calendar" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -23401,7 +29180,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "calendars" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCalendarsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Calendar" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "calendars" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCalendar", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Calendar" + } + } + }, + "description": "The JSON representation of the Calendar resource to be created or updated.", + "required": true, + "x-bodyName": "Calendar" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23618,6 +29512,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CareerPathwayDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CareerPathwayDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CareerPathwayDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -23734,7 +29689,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23777,7 +29732,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23797,27 +29752,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/careerPathwayDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCareerPathwaysById", + "/ed-fi/careerPathwayDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCareerPathwaysDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -23831,48 +29799,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "careerPathwayDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/careerPathwayDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCareerPathwaysById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCareerPathwaysKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -23880,14 +29837,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -23899,20 +29856,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "careerPathwayDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCareerPathway", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/careerPathwayDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCareerPathwaysById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -23927,18 +29888,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor" - } - } - }, - "description": "The JSON representation of the CareerPathway resource to be created or updated.", - "required": true, - "x-bodyName": "CareerPathway" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -23956,7 +29905,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "careerPathwayDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCareerPathwaysById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "careerPathwayDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCareerPathway", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor" + } + } + }, + "description": "The JSON representation of the CareerPathway resource to be created or updated.", + "required": true, + "x-bodyName": "CareerPathway" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24743,6 +30807,72 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ChartOfAccount_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ChartOfAccount_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ChartOfAccount_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -24931,7 +31061,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24974,7 +31104,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24995,27 +31125,40 @@ "Finance" ] }, - "/ed-fi/chartOfAccounts/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteChartOfAccountsById", + "/ed-fi/chartOfAccounts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getChartOfAccountsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -25029,48 +31172,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "chartOfAccounts" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/chartOfAccounts/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getChartOfAccountsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getChartOfAccountsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -25078,14 +31211,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ChartOfAccount" + "items": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -25097,20 +31230,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "chartOfAccounts" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putChartOfAccount", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/chartOfAccounts/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteChartOfAccountsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -25125,18 +31263,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ChartOfAccount" - } - } - }, - "description": "The JSON representation of the ChartOfAccount resource to be created or updated.", - "required": true, - "x-bodyName": "ChartOfAccount" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -25154,7 +31280,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "chartOfAccounts" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getChartOfAccountsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "chartOfAccounts" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putChartOfAccount", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount" + } + } + }, + "description": "The JSON representation of the ChartOfAccount resource to be created or updated.", + "required": true, + "x-bodyName": "ChartOfAccount" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25437,6 +31678,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -25553,7 +31855,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25596,7 +31898,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25616,27 +31918,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/charterApprovalAgencyTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCharterApprovalAgencyTypesById", + "/ed-fi/charterApprovalAgencyTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCharterApprovalAgencyTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -25650,48 +31965,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "charterApprovalAgencyTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/charterApprovalAgencyTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCharterApprovalAgencyTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCharterApprovalAgencyTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -25699,14 +32003,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -25718,20 +32022,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "charterApprovalAgencyTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCharterApprovalAgencyType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/charterApprovalAgencyTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCharterApprovalAgencyTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -25746,18 +32054,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CharterApprovalAgencyType resource to be created or updated.", - "required": true, - "x-bodyName": "CharterApprovalAgencyType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -25775,7 +32071,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "charterApprovalAgencyTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCharterApprovalAgencyTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "charterApprovalAgencyTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCharterApprovalAgencyType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CharterApprovalAgencyType resource to be created or updated.", + "required": true, + "x-bodyName": "CharterApprovalAgencyType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26000,6 +32411,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CharterStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CharterStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CharterStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -26116,7 +32588,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -26159,7 +32631,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26179,27 +32651,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/charterStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCharterStatusesById", + "/ed-fi/charterStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCharterStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -26213,48 +32698,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "charterStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/charterStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCharterStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCharterStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -26262,14 +32736,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -26281,20 +32755,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "charterStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCharterStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/charterStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCharterStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -26309,18 +32787,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor" - } - } - }, - "description": "The JSON representation of the CharterStatus resource to be created or updated.", - "required": true, - "x-bodyName": "CharterStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -26338,7 +32804,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "charterStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCharterStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "charterStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCharterStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor" + } + } + }, + "description": "The JSON representation of the CharterStatus resource to be created or updated.", + "required": true, + "x-bodyName": "CharterStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26563,6 +33144,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CitizenshipStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CitizenshipStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CitizenshipStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -26679,7 +33321,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -26722,7 +33364,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26742,27 +33384,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/citizenshipStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCitizenshipStatusesById", + "/ed-fi/citizenshipStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCitizenshipStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -26776,48 +33431,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "citizenshipStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/citizenshipStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCitizenshipStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCitizenshipStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -26825,14 +33469,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -26844,20 +33488,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "citizenshipStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCitizenshipStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/citizenshipStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCitizenshipStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -26872,18 +33520,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor" - } - } - }, - "description": "The JSON representation of the CitizenshipStatus resource to be created or updated.", - "required": true, - "x-bodyName": "CitizenshipStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -26901,7 +33537,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "citizenshipStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCitizenshipStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "citizenshipStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCitizenshipStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor" + } + } + }, + "description": "The JSON representation of the CitizenshipStatus resource to be created or updated.", + "required": true, + "x-bodyName": "CitizenshipStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27215,6 +33966,67 @@ "schoolId" ], "type": "object" + }, + "EdFi_ClassPeriod_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ClassPeriod_TrackedChangeKey": { + "properties": { + "classPeriodName": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "classPeriodName", + "schoolId" + ], + "type": "object" + }, + "EdFi_ClassPeriod_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -27303,7 +34115,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27346,7 +34158,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27369,27 +34181,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/classPeriods/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteClassPeriodsById", + "/ed-fi/classPeriods/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getClassPeriodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -27403,48 +34228,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "classPeriods" ] }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/classPeriods/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getClassPeriodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getClassPeriodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -27452,14 +34269,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ClassPeriod" + "items": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -27471,20 +34288,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "classPeriods" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putClassPeriod", + "x-Ed-Fi-domains": [ + "BellSchedule", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/classPeriods/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteClassPeriodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -27499,18 +34323,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ClassPeriod" - } - } - }, - "description": "The JSON representation of the ClassPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "ClassPeriod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -27528,7 +34340,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "classPeriods" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getClassPeriodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ClassPeriod" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "classPeriods" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putClassPeriod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ClassPeriod" + } + } + }, + "description": "The JSON representation of the ClassPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "ClassPeriod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27742,6 +34669,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ClassroomPositionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ClassroomPositionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ClassroomPositionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -27858,7 +34846,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27901,7 +34889,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27921,27 +34909,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/classroomPositionDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteClassroomPositionsById", + "/ed-fi/classroomPositionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getClassroomPositionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -27955,48 +34956,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "classroomPositionDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/classroomPositionDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getClassroomPositionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getClassroomPositionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -28004,14 +34994,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -28023,20 +35013,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "classroomPositionDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putClassroomPosition", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/classroomPositionDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteClassroomPositionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -28051,18 +35045,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor" - } - } - }, - "description": "The JSON representation of the ClassroomPosition resource to be created or updated.", - "required": true, - "x-bodyName": "ClassroomPosition" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -28080,7 +35062,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "classroomPositionDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getClassroomPositionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "classroomPositionDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putClassroomPosition", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor" + } + } + }, + "description": "The JSON representation of the ClassroomPosition resource to be created or updated.", + "required": true, + "x-bodyName": "ClassroomPosition" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28305,6 +35402,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CohortScopeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CohortScopeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CohortScopeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -28421,7 +35579,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28464,7 +35622,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28484,27 +35642,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/cohortScopeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCohortScopesById", + "/ed-fi/cohortScopeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortScopesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -28518,48 +35689,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "cohortScopeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortScopeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCohortScopesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortScopesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -28567,14 +35727,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -28586,20 +35746,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "cohortScopeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCohortScope", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortScopeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCohortScopesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -28614,18 +35778,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor" - } - } - }, - "description": "The JSON representation of the CohortScope resource to be created or updated.", - "required": true, - "x-bodyName": "CohortScope" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -28643,7 +35795,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "cohortScopeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCohortScopesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "cohortScopeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCohortScope", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor" + } + } + }, + "description": "The JSON representation of the CohortScope resource to be created or updated.", + "required": true, + "x-bodyName": "CohortScope" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28868,6 +36135,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CohortTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CohortTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CohortTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -28984,7 +36312,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29027,7 +36355,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29047,27 +36375,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/cohortTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCohortTypesById", + "/ed-fi/cohortTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -29081,48 +36422,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "cohortTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCohortTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -29130,14 +36460,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -29149,20 +36479,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "cohortTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCohortType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCohortTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -29177,18 +36511,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CohortType resource to be created or updated.", - "required": true, - "x-bodyName": "CohortType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -29206,7 +36528,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "cohortTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCohortTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "cohortTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCohortType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CohortType resource to be created or updated.", + "required": true, + "x-bodyName": "CohortType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29431,6 +36868,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CohortYearTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CohortYearTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CohortYearTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -29547,7 +37045,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29590,7 +37088,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29610,27 +37108,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/cohortYearTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCohortYearTypesById", + "/ed-fi/cohortYearTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortYearTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -29644,48 +37155,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "cohortYearTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortYearTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCohortYearTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortYearTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -29693,14 +37193,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -29712,20 +37212,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "cohortYearTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCohortYearType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortYearTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCohortYearTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -29740,18 +37244,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CohortYearType resource to be created or updated.", - "required": true, - "x-bodyName": "CohortYearType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -29769,7 +37261,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "cohortYearTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCohortYearTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "cohortYearTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCohortYearType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CohortYearType resource to be created or updated.", + "required": true, + "x-bodyName": "CohortYearType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -30161,6 +37768,67 @@ "educationOrganizationId" ], "type": "object" + }, + "EdFi_Cohort_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Cohort_TrackedChangeKey": { + "properties": { + "cohortIdentifier": { + "maxLength": 36, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "cohortIdentifier", + "educationOrganizationId" + ], + "type": "object" + }, + "EdFi_Cohort_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -30277,7 +37945,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30320,7 +37988,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -30342,27 +38010,40 @@ "StudentCohort" ] }, - "/ed-fi/cohorts/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCohortsById", + "/ed-fi/cohorts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -30376,48 +38057,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "cohorts" ] }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/cohorts/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCohortsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -30425,14 +38097,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Cohort" + "items": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -30444,20 +38116,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "cohorts" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCohort", + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/cohorts/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCohortsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -30472,18 +38150,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Cohort" - } - } - }, - "description": "The JSON representation of the Cohort resource to be created or updated.", - "required": true, - "x-bodyName": "Cohort" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -30501,7 +38167,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "cohorts" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCohortsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Cohort" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "cohorts" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCohort", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Cohort" + } + } + }, + "description": "The JSON representation of the Cohort resource to be created or updated.", + "required": true, + "x-bodyName": "Cohort" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31493,6 +39274,62 @@ ], "type": "object" }, + "EdFi_CommunityOrganization_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CommunityOrganization_TrackedChangeKey": { + "properties": { + "communityOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "communityOrganizationId" + ], + "type": "object" + }, + "EdFi_CommunityOrganization_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_EducationOrganization_Address": { "properties": { "addressTypeDescriptor": { @@ -31881,7 +39718,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31924,7 +39761,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31945,27 +39782,40 @@ "EducationOrganization" ] }, - "/ed-fi/communityOrganizations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCommunityOrganizationsById", + "/ed-fi/communityOrganizations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityOrganizationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -31979,48 +39829,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "communityOrganizations" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityOrganizations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCommunityOrganizationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityOrganizationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -32028,14 +39868,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CommunityOrganization" + "items": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -32047,20 +39887,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "communityOrganizations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCommunityOrganization", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityOrganizations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCommunityOrganizationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -32075,18 +39920,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CommunityOrganization" - } - } - }, - "description": "The JSON representation of the CommunityOrganization resource to be created or updated.", - "required": true, - "x-bodyName": "CommunityOrganization" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -32104,7 +39937,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "communityOrganizations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCommunityOrganizationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "communityOrganizations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCommunityOrganization", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization" + } + } + }, + "description": "The JSON representation of the CommunityOrganization resource to be created or updated.", + "required": true, + "x-bodyName": "CommunityOrganization" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -32523,6 +40471,72 @@ "licensingOrganization" ], "type": "object" + }, + "EdFi_CommunityProviderLicense_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CommunityProviderLicense_TrackedChangeKey": { + "properties": { + "communityProviderId": { + "format": "int64", + "type": "integer" + }, + "licenseIdentifier": { + "maxLength": 36, + "type": "string" + }, + "licensingOrganization": { + "maxLength": 75, + "type": "string" + } + }, + "required": [ + "communityProviderId", + "licenseIdentifier", + "licensingOrganization" + ], + "type": "object" + }, + "EdFi_CommunityProviderLicense_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -32685,7 +40699,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32728,7 +40742,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -32749,27 +40763,40 @@ "EducationOrganization" ] }, - "/ed-fi/communityProviderLicenses/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCommunityProviderLicensesById", + "/ed-fi/communityProviderLicenses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProviderLicensesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -32783,48 +40810,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "communityProviderLicenses" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityProviderLicenses/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCommunityProviderLicensesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProviderLicensesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -32832,14 +40849,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CommunityProviderLicense" + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -32851,20 +40868,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "communityProviderLicenses" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCommunityProviderLicense", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityProviderLicenses/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCommunityProviderLicensesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -32879,18 +40901,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CommunityProviderLicense" - } - } - }, - "description": "The JSON representation of the CommunityProviderLicense resource to be created or updated.", - "required": true, - "x-bodyName": "CommunityProviderLicense" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -32908,7 +40918,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "communityProviderLicenses" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCommunityProviderLicensesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "communityProviderLicenses" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCommunityProviderLicense", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense" + } + } + }, + "description": "The JSON representation of the CommunityProviderLicense resource to be created or updated.", + "required": true, + "x-bodyName": "CommunityProviderLicense" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34057,6 +42182,62 @@ ], "type": "object" }, + "EdFi_CommunityProvider_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CommunityProvider_TrackedChangeKey": { + "properties": { + "communityProviderId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "communityProviderId" + ], + "type": "object" + }, + "EdFi_CommunityProvider_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_EducationOrganization_Address": { "properties": { "addressTypeDescriptor": { @@ -34498,7 +42679,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34541,7 +42722,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34562,27 +42743,40 @@ "EducationOrganization" ] }, - "/ed-fi/communityProviders/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCommunityProvidersById", + "/ed-fi/communityProviders/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProvidersDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -34596,48 +42790,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "communityProviders" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityProviders/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCommunityProvidersById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProvidersKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -34645,14 +42829,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CommunityProvider" + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -34664,20 +42848,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "communityProviders" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCommunityProvider", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityProviders/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCommunityProvidersById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -34692,18 +42881,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CommunityProvider" - } - } - }, - "description": "The JSON representation of the CommunityProvider resource to be created or updated.", - "required": true, - "x-bodyName": "CommunityProvider" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -34721,7 +42898,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "communityProviders" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCommunityProvidersById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityProvider" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "communityProviders" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCommunityProvider", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityProvider" + } + } + }, + "description": "The JSON representation of the CommunityProvider resource to be created or updated.", + "required": true, + "x-bodyName": "CommunityProvider" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34991,6 +43283,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CompetencyLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CompetencyLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CompetencyLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -35107,7 +43460,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35150,7 +43503,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -35170,27 +43523,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/competencyLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCompetencyLevelsById", + "/ed-fi/competencyLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -35204,48 +43570,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "competencyLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/competencyLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCompetencyLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -35253,14 +43608,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -35272,20 +43627,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "competencyLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCompetencyLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/competencyLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCompetencyLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -35300,18 +43659,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor" - } - } - }, - "description": "The JSON representation of the CompetencyLevel resource to be created or updated.", - "required": true, - "x-bodyName": "CompetencyLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -35329,7 +43676,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "competencyLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCompetencyLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "competencyLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCompetencyLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor" + } + } + }, + "description": "The JSON representation of the CompetencyLevel resource to be created or updated.", + "required": true, + "x-bodyName": "CompetencyLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -35638,6 +44100,72 @@ "objectiveGradeLevelDescriptor" ], "type": "object" + }, + "EdFi_CompetencyObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CompetencyObjective_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "objective": { + "maxLength": 60, + "type": "string" + }, + "objectiveGradeLevelDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor" + ], + "type": "object" + }, + "EdFi_CompetencyObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -35755,7 +44283,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35798,7 +44326,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -35820,27 +44348,40 @@ "ReportCard" ] }, - "/ed-fi/competencyObjectives/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCompetencyObjectivesById", + "/ed-fi/competencyObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyObjectivesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -35854,48 +44395,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "competencyObjectives" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/competencyObjectives/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCompetencyObjectivesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyObjectivesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -35903,14 +44435,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CompetencyObjective" + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -35922,20 +44454,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "competencyObjectives" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCompetencyObjective", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/competencyObjectives/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCompetencyObjectivesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -35950,18 +44488,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CompetencyObjective" - } - } - }, - "description": "The JSON representation of the CompetencyObjective resource to be created or updated.", - "required": true, - "x-bodyName": "CompetencyObjective" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -35979,7 +44505,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "competencyObjectives" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCompetencyObjectivesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "competencyObjectives" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCompetencyObjective", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective" + } + } + }, + "description": "The JSON representation of the CompetencyObjective resource to be created or updated.", + "required": true, + "x-bodyName": "CompetencyObjective" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -36209,6 +44850,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ContactTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContactTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ContactTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -36325,7 +45027,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36368,7 +45070,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -36388,27 +45090,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/contactTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteContactTypesById", + "/ed-fi/contactTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContactTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -36422,48 +45137,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "contactTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/contactTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getContactTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContactTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -36471,14 +45175,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -36490,20 +45194,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "contactTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putContactType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/contactTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteContactTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -36518,18 +45226,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ContactType resource to be created or updated.", - "required": true, - "x-bodyName": "ContactType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -36547,7 +45243,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "contactTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getContactTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "contactTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putContactType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ContactType resource to be created or updated.", + "required": true, + "x-bodyName": "ContactType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38285,6 +47096,62 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "EdFi_Contact_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Contact_TrackedChangeKey": { + "properties": { + "contactUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "contactUniqueId" + ], + "type": "object" + }, + "EdFi_Contact_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -38483,7 +47350,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38526,7 +47393,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38547,27 +47414,40 @@ "StudentIdentificationAndDemographics" ] }, - "/ed-fi/contacts/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteContactsById", + "/ed-fi/contacts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContactsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -38581,48 +47461,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "contacts" ] }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/contacts/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getContactsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContactsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -38630,14 +47500,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Contact" + "items": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -38649,20 +47519,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "contacts" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putContact", + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/contacts/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteContactsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -38677,18 +47552,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Contact" - } - } - }, - "description": "The JSON representation of the Contact resource to be created or updated.", - "required": true, - "x-bodyName": "Contact" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -38706,7 +47569,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "contacts" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getContactsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Contact" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "contacts" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putContact", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Contact" + } + } + }, + "description": "The JSON representation of the Contact resource to be created or updated.", + "required": true, + "x-bodyName": "Contact" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38994,6 +47972,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ContentClassDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContentClassDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ContentClassDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -39110,7 +48149,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39153,7 +48192,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -39173,27 +48212,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/contentClassDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteContentClassesById", + "/ed-fi/contentClassDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContentClassesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -39207,48 +48259,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "contentClassDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/contentClassDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getContentClassesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContentClassesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -39256,14 +48297,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ContentClassDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -39275,20 +48316,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "contentClassDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putContentClass", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/contentClassDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteContentClassesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -39303,18 +48348,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ContentClassDescriptor" - } - } - }, - "description": "The JSON representation of the ContentClass resource to be created or updated.", - "required": true, - "x-bodyName": "ContentClass" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -39332,7 +48365,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "contentClassDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getContentClassesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "contentClassDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putContentClass", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor" + } + } + }, + "description": "The JSON representation of the ContentClass resource to be created or updated.", + "required": true, + "x-bodyName": "ContentClass" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -39557,6 +48705,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -39673,7 +48882,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39716,7 +48925,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -39736,27 +48945,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/continuationOfServicesReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteContinuationOfServicesReasonsById", + "/ed-fi/continuationOfServicesReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContinuationOfServicesReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -39770,48 +48992,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "continuationOfServicesReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/continuationOfServicesReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getContinuationOfServicesReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContinuationOfServicesReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -39819,14 +49030,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -39838,20 +49049,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "continuationOfServicesReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putContinuationOfServicesReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/continuationOfServicesReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteContinuationOfServicesReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -39866,18 +49081,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor" - } - } - }, - "description": "The JSON representation of the ContinuationOfServicesReason resource to be created or updated.", - "required": true, - "x-bodyName": "ContinuationOfServicesReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -39895,7 +49098,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "continuationOfServicesReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getContinuationOfServicesReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "continuationOfServicesReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putContinuationOfServicesReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor" + } + } + }, + "description": "The JSON representation of the ContinuationOfServicesReason resource to be created or updated.", + "required": true, + "x-bodyName": "ContinuationOfServicesReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -40120,6 +49438,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CostRateDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CostRateDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CostRateDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -40236,7 +49615,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -40279,7 +49658,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -40299,27 +49678,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/costRateDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCostRatesById", + "/ed-fi/costRateDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCostRatesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -40333,48 +49725,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "costRateDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/costRateDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCostRatesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCostRatesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -40382,14 +49763,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CostRateDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -40401,20 +49782,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "costRateDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCostRate", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/costRateDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCostRatesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -40429,18 +49814,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CostRateDescriptor" - } - } - }, - "description": "The JSON representation of the CostRate resource to be created or updated.", - "required": true, - "x-bodyName": "CostRate" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -40458,7 +49831,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "costRateDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCostRatesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "costRateDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCostRate", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor" + } + } + }, + "description": "The JSON representation of the CostRate resource to be created or updated.", + "required": true, + "x-bodyName": "CostRate" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -40683,6 +50171,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CountryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CountryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CountryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -40799,7 +50348,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -40842,7 +50391,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -40862,27 +50411,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/countryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCountriesById", + "/ed-fi/countryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCountriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -40896,48 +50458,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "countryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/countryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCountriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCountriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -40945,14 +50496,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CountryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -40964,20 +50515,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "countryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCountry", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/countryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCountriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -40992,18 +50547,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CountryDescriptor" - } - } - }, - "description": "The JSON representation of the Country resource to be created or updated.", - "required": true, - "x-bodyName": "Country" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -41021,7 +50564,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "countryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCountriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "countryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCountry", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor" + } + } + }, + "description": "The JSON representation of the Country resource to be created or updated.", + "required": true, + "x-bodyName": "Country" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -41246,6 +50904,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseAttemptResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseAttemptResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseAttemptResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -41362,7 +51081,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -41405,7 +51124,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -41425,27 +51144,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseAttemptResultDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseAttemptResultsById", + "/ed-fi/courseAttemptResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseAttemptResultsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -41459,48 +51191,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseAttemptResultDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseAttemptResultDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseAttemptResultsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseAttemptResultsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -41508,14 +51229,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -41527,20 +51248,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseAttemptResultDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseAttemptResult", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseAttemptResultDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseAttemptResultsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -41555,18 +51280,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor" - } - } - }, - "description": "The JSON representation of the CourseAttemptResult resource to be created or updated.", - "required": true, - "x-bodyName": "CourseAttemptResult" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -41584,7 +51297,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseAttemptResultDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseAttemptResultsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseAttemptResultDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseAttemptResult", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor" + } + } + }, + "description": "The JSON representation of the CourseAttemptResult resource to be created or updated.", + "required": true, + "x-bodyName": "CourseAttemptResult" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -41809,6 +51637,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseDefinedByDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseDefinedByDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseDefinedByDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -41925,7 +51814,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -41968,7 +51857,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -41988,27 +51877,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseDefinedByDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseDefinedBiesById", + "/ed-fi/courseDefinedByDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseDefinedBiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -42022,48 +51924,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseDefinedByDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseDefinedByDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseDefinedBiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseDefinedBiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -42071,14 +51962,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -42090,20 +51981,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseDefinedByDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseDefinedBy", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseDefinedByDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseDefinedBiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -42118,18 +52013,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor" - } - } - }, - "description": "The JSON representation of the CourseDefinedBy resource to be created or updated.", - "required": true, - "x-bodyName": "CourseDefinedBy" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -42147,7 +52030,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseDefinedByDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseDefinedBiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseDefinedByDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseDefinedBy", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor" + } + } + }, + "description": "The JSON representation of the CourseDefinedBy resource to be created or updated.", + "required": true, + "x-bodyName": "CourseDefinedBy" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -42372,6 +52370,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -42488,7 +52547,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -42531,7 +52590,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -42551,27 +52610,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseGPAApplicabilityDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseGPAApplicabilitiesById", + "/ed-fi/courseGPAApplicabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseGPAApplicabilitiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -42585,48 +52657,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseGPAApplicabilityDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseGPAApplicabilityDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseGPAApplicabilitiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseGPAApplicabilitiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -42634,14 +52695,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -42653,20 +52714,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseGPAApplicabilityDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseGPAApplicability", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseGPAApplicabilityDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseGPAApplicabilitiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -42681,18 +52746,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor" - } - } - }, - "description": "The JSON representation of the CourseGPAApplicability resource to be created or updated.", - "required": true, - "x-bodyName": "CourseGPAApplicability" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -42710,7 +52763,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseGPAApplicabilityDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseGPAApplicabilitiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseGPAApplicabilityDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseGPAApplicability", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor" + } + } + }, + "description": "The JSON representation of the CourseGPAApplicability resource to be created or updated.", + "required": true, + "x-bodyName": "CourseGPAApplicability" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -42935,6 +53103,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -43051,7 +53280,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43094,7 +53323,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -43114,27 +53343,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseIdentificationSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseIdentificationSystemsById", + "/ed-fi/courseIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseIdentificationSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -43148,48 +53390,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseIdentificationSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseIdentificationSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseIdentificationSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseIdentificationSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -43197,14 +53428,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -43216,20 +53447,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseIdentificationSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseIdentificationSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseIdentificationSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseIdentificationSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -43244,18 +53479,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor" - } - } - }, - "description": "The JSON representation of the CourseIdentificationSystem resource to be created or updated.", - "required": true, - "x-bodyName": "CourseIdentificationSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -43273,7 +53496,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseIdentificationSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseIdentificationSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseIdentificationSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseIdentificationSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor" + } + } + }, + "description": "The JSON representation of the CourseIdentificationSystem resource to be created or updated.", + "required": true, + "x-bodyName": "CourseIdentificationSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -43498,6 +53836,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -43614,7 +54013,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43657,7 +54056,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -43677,27 +54076,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseLevelCharacteristicDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseLevelCharacteristicsById", + "/ed-fi/courseLevelCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseLevelCharacteristicsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -43711,48 +54123,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseLevelCharacteristicDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseLevelCharacteristicDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseLevelCharacteristicsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseLevelCharacteristicsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -43760,14 +54161,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -43779,20 +54180,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseLevelCharacteristicDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseLevelCharacteristic", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseLevelCharacteristicDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseLevelCharacteristicsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -43807,18 +54212,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor" - } - } - }, - "description": "The JSON representation of the CourseLevelCharacteristic resource to be created or updated.", - "required": true, - "x-bodyName": "CourseLevelCharacteristic" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -43836,7 +54229,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseLevelCharacteristicDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseLevelCharacteristicsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseLevelCharacteristicDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseLevelCharacteristic", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor" + } + } + }, + "description": "The JSON representation of the CourseLevelCharacteristic resource to be created or updated.", + "required": true, + "x-bodyName": "CourseLevelCharacteristic" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44397,6 +54905,77 @@ "sessionName" ], "type": "object" + }, + "EdFi_CourseOffering_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseOffering_TrackedChangeKey": { + "properties": { + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName" + ], + "type": "object" + }, + "EdFi_CourseOffering_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -44535,7 +55114,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44578,7 +55157,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44602,27 +55181,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/courseOfferings/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseOfferingsById", + "/ed-fi/courseOfferings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseOfferingsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -44636,48 +55228,41 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseOfferings" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/courseOfferings/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseOfferingsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseOfferingsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -44685,14 +55270,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseOffering" + "items": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -44704,20 +55289,28 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseOfferings" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseOffering", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/courseOfferings/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseOfferingsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -44732,18 +55325,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseOffering" - } - } - }, - "description": "The JSON representation of the CourseOffering resource to be created or updated.", - "required": true, - "x-bodyName": "CourseOffering" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -44761,7 +55342,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseOfferings" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseOfferingsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseOffering" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseOfferings" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseOffering", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseOffering" + } + } + }, + "description": "The JSON representation of the CourseOffering resource to be created or updated.", + "required": true, + "x-bodyName": "CourseOffering" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -45009,6 +55705,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseRepeatCodeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseRepeatCodeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -45125,7 +55882,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -45168,7 +55925,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -45188,27 +55945,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseRepeatCodeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseRepeatCodesById", + "/ed-fi/courseRepeatCodeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseRepeatCodesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -45222,48 +55992,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseRepeatCodeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseRepeatCodeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseRepeatCodesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseRepeatCodesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -45271,14 +56030,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -45290,20 +56049,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseRepeatCodeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseRepeatCode", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseRepeatCodeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseRepeatCodesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -45318,18 +56081,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor" - } - } - }, - "description": "The JSON representation of the CourseRepeatCode resource to be created or updated.", - "required": true, - "x-bodyName": "CourseRepeatCode" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -45347,7 +56098,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseRepeatCodeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseRepeatCodesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseRepeatCodeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseRepeatCode", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor" + } + } + }, + "description": "The JSON representation of the CourseRepeatCode resource to be created or updated.", + "required": true, + "x-bodyName": "CourseRepeatCode" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -46741,6 +57607,92 @@ "sectionReference" ], "type": "object" + }, + "EdFi_CourseTranscript_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseTranscript_TrackedChangeKey": { + "properties": { + "courseAttemptResultDescriptor": { + "maxLength": 306, + "type": "string" + }, + "courseCode": { + "maxLength": 60, + "type": "string" + }, + "courseEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "courseAttemptResultDescriptor", + "courseCode", + "courseEducationOrganizationId", + "educationOrganizationId", + "schoolYear", + "studentUniqueId", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_CourseTranscript_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -47036,7 +57988,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47079,7 +58031,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -47101,27 +58053,40 @@ "StudentTranscript" ] }, - "/ed-fi/courseTranscripts/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseTranscriptsById", + "/ed-fi/courseTranscripts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseTranscriptsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -47135,48 +58100,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseTranscripts" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "StudentTranscript" + ] + }, + "/ed-fi/courseTranscripts/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseTranscriptsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseTranscriptsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -47184,14 +58140,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseTranscript" + "items": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -47203,20 +58159,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseTranscripts" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseTranscript", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "StudentTranscript" + ] + }, + "/ed-fi/courseTranscripts/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseTranscriptsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -47231,18 +58193,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseTranscript" - } - } - }, - "description": "The JSON representation of the CourseTranscript resource to be created or updated.", - "required": true, - "x-bodyName": "CourseTranscript" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -47260,7 +58210,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseTranscripts" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseTranscriptsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseTranscript" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseTranscripts" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseTranscript", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseTranscript" + } + } + }, + "description": "The JSON representation of the CourseTranscript resource to be created or updated.", + "required": true, + "x-bodyName": "CourseTranscript" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48354,6 +59419,67 @@ "educationOrganizationId" ], "type": "object" + }, + "EdFi_Course_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Course_TrackedChangeKey": { + "properties": { + "courseCode": { + "maxLength": 60, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "courseCode", + "educationOrganizationId" + ], + "type": "object" + }, + "EdFi_Course_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -48577,7 +59703,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -48620,7 +59746,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48645,27 +59771,40 @@ "StudentTranscript" ] }, - "/ed-fi/courses/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCoursesById", + "/ed-fi/courses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCoursesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -48679,48 +59818,42 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courses" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "StudentTranscript" + ] + }, + "/ed-fi/courses/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCoursesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCoursesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -48728,14 +59861,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Course" + "items": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -48747,20 +59880,29 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courses" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourse", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "StudentTranscript" + ] + }, + "/ed-fi/courses/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCoursesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -48775,18 +59917,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Course" - } - } - }, - "description": "The JSON representation of the Course resource to be created or updated.", - "required": true, - "x-bodyName": "Course" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -48804,7 +59934,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courses" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCoursesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Course" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courses" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourse", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Course" + } + } + }, + "description": "The JSON representation of the Course resource to be created or updated.", + "required": true, + "x-bodyName": "Course" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -49115,6 +60360,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CredentialFieldDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CredentialFieldDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CredentialFieldDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -49231,7 +60537,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49274,7 +60580,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -49294,27 +60600,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/credentialFieldDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCredentialFieldsById", + "/ed-fi/credentialFieldDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialFieldsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -49328,48 +60647,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "credentialFieldDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/credentialFieldDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCredentialFieldsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialFieldsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -49377,14 +60685,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -49396,20 +60704,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "credentialFieldDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCredentialField", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/credentialFieldDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCredentialFieldsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -49424,18 +60736,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor" - } - } - }, - "description": "The JSON representation of the CredentialField resource to be created or updated.", - "required": true, - "x-bodyName": "CredentialField" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -49453,7 +60753,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "credentialFieldDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCredentialFieldsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "credentialFieldDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCredentialField", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor" + } + } + }, + "description": "The JSON representation of the CredentialField resource to be created or updated.", + "required": true, + "x-bodyName": "CredentialField" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -49678,6 +61093,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CredentialTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CredentialTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CredentialTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -49794,7 +61270,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49837,7 +61313,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -49857,27 +61333,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/credentialTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCredentialTypesById", + "/ed-fi/credentialTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -49891,48 +61380,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "credentialTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/credentialTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCredentialTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -49940,14 +61418,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -49959,20 +61437,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "credentialTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCredentialType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/credentialTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCredentialTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -49987,18 +61469,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CredentialType resource to be created or updated.", - "required": true, - "x-bodyName": "CredentialType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -50016,7 +61486,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "credentialTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCredentialTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "credentialTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCredentialType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CredentialType resource to be created or updated.", + "required": true, + "x-bodyName": "CredentialType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -50553,6 +62138,67 @@ "stateOfIssueStateAbbreviationDescriptor" ], "type": "object" + }, + "EdFi_Credential_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Credential_TrackedChangeKey": { + "properties": { + "credentialIdentifier": { + "maxLength": 60, + "type": "string" + }, + "stateOfIssueStateAbbreviationDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "credentialIdentifier", + "stateOfIssueStateAbbreviationDescriptor" + ], + "type": "object" + }, + "EdFi_Credential_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -50706,7 +62352,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -50749,7 +62395,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -50770,27 +62416,40 @@ "Staff" ] }, - "/ed-fi/credentials/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCredentialsById", + "/ed-fi/credentials/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -50804,48 +62463,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "credentials" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/credentials/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCredentialsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -50853,14 +62502,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Credential" + "items": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -50872,20 +62521,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "credentials" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCredential", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/credentials/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCredentialsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -50900,18 +62554,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Credential" - } - } - }, - "description": "The JSON representation of the Credential resource to be created or updated.", - "required": true, - "x-bodyName": "Credential" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -50929,7 +62571,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "credentials" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCredentialsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Credential" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "credentials" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCredential", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Credential" + } + } + }, + "description": "The JSON representation of the Credential resource to be created or updated.", + "required": true, + "x-bodyName": "Credential" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51184,6 +62941,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CreditCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CreditCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CreditCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -51300,7 +63118,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51343,7 +63161,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51363,27 +63181,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/creditCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCreditCategoriesById", + "/ed-fi/creditCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCreditCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -51397,48 +63228,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "creditCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/creditCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCreditCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCreditCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -51446,14 +63266,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -51465,20 +63285,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "creditCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCreditCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/creditCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCreditCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -51493,18 +63317,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the CreditCategory resource to be created or updated.", - "required": true, - "x-bodyName": "CreditCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -51522,7 +63334,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "creditCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCreditCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "creditCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCreditCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the CreditCategory resource to be created or updated.", + "required": true, + "x-bodyName": "CreditCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51747,6 +63674,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CreditTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CreditTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CreditTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -51863,7 +63851,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51906,7 +63894,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51926,27 +63914,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/creditTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCreditTypesById", + "/ed-fi/creditTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCreditTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -51960,48 +63961,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "creditTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/creditTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCreditTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCreditTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -52009,14 +63999,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -52028,20 +64018,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "creditTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCreditType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/creditTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCreditTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -52056,18 +64050,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CreditType resource to be created or updated.", - "required": true, - "x-bodyName": "CreditType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -52085,7 +64067,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "creditTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCreditTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "creditTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCreditType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CreditType resource to be created or updated.", + "required": true, + "x-bodyName": "CreditType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52342,6 +64439,62 @@ "crisisEventName" ], "type": "object" + }, + "EdFi_CrisisEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CrisisEvent_TrackedChangeKey": { + "properties": { + "crisisEventName": { + "maxLength": 100, + "type": "string" + } + }, + "required": [ + "crisisEventName" + ], + "type": "object" + }, + "EdFi_CrisisEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -52448,7 +64601,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52491,7 +64644,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52512,27 +64665,40 @@ "Enrollment" ] }, - "/ed-fi/crisisEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCrisisEventsById", + "/ed-fi/crisisEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCrisisEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -52546,48 +64712,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "crisisEvents" ] }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/crisisEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCrisisEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCrisisEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -52595,14 +64751,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CrisisEvent" + "items": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -52614,20 +64770,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "crisisEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCrisisEvent", + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/crisisEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCrisisEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -52642,18 +64803,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CrisisEvent" - } - } - }, - "description": "The JSON representation of the CrisisEvent resource to be created or updated.", - "required": true, - "x-bodyName": "CrisisEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -52671,7 +64820,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "crisisEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCrisisEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CrisisEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "crisisEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCrisisEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CrisisEvent" + } + } + }, + "description": "The JSON representation of the CrisisEvent resource to be created or updated.", + "required": true, + "x-bodyName": "CrisisEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52890,6 +65154,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CrisisTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CrisisTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CrisisTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -53006,7 +65331,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53049,7 +65374,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53069,27 +65394,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/crisisTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCrisisTypesById", + "/ed-fi/crisisTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCrisisTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -53103,48 +65441,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "crisisTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/crisisTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCrisisTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCrisisTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -53152,14 +65479,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -53171,20 +65498,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "crisisTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCrisisType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/crisisTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCrisisTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -53199,18 +65530,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CrisisType resource to be created or updated.", - "required": true, - "x-bodyName": "CrisisType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -53228,7 +65547,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "crisisTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCrisisTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "crisisTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCrisisType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CrisisType resource to be created or updated.", + "required": true, + "x-bodyName": "CrisisType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53453,6 +65887,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CteProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CteProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CteProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -53569,7 +66064,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53612,7 +66107,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53632,27 +66127,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/cteProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCTEProgramServicesById", + "/ed-fi/cteProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCTEProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -53666,48 +66174,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "cteProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cteProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCTEProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCTEProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -53715,14 +66212,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -53734,20 +66231,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "cteProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCTEProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cteProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCTEProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -53762,18 +66263,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the CTEProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "CTEProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -53791,7 +66280,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "cteProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCTEProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "cteProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCTEProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the CTEProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "CTEProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54016,6 +66620,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CurriculumUsedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CurriculumUsedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CurriculumUsedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -54132,7 +66797,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54175,7 +66840,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54195,27 +66860,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/curriculumUsedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCurriculumUsedsById", + "/ed-fi/curriculumUsedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCurriculumUsedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54229,48 +66907,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "curriculumUsedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/curriculumUsedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCurriculumUsedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCurriculumUsedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -54278,14 +66945,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54297,20 +66964,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "curriculumUsedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCurriculumUsed", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/curriculumUsedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCurriculumUsedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -54325,18 +66996,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor" - } - } - }, - "description": "The JSON representation of the CurriculumUsed resource to be created or updated.", - "required": true, - "x-bodyName": "CurriculumUsed" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -54354,7 +67013,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "curriculumUsedDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCurriculumUsedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "curriculumUsedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCurriculumUsed", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor" + } + } + }, + "description": "The JSON representation of the CurriculumUsed resource to be created or updated.", + "required": true, + "x-bodyName": "CurriculumUsed" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54579,6 +67353,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DeliveryMethodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DeliveryMethodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DeliveryMethodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -54695,7 +67530,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54738,7 +67573,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54758,27 +67593,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/deliveryMethodDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDeliveryMethodsById", + "/ed-fi/deliveryMethodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDeliveryMethodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54792,48 +67640,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "deliveryMethodDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/deliveryMethodDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDeliveryMethodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDeliveryMethodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -54841,14 +67678,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54860,20 +67697,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "deliveryMethodDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDeliveryMethod", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/deliveryMethodDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDeliveryMethodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -54888,18 +67729,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor" - } - } - }, - "description": "The JSON representation of the DeliveryMethod resource to be created or updated.", - "required": true, - "x-bodyName": "DeliveryMethod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -54917,7 +67746,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "deliveryMethodDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDeliveryMethodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "deliveryMethodDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDeliveryMethod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor" + } + } + }, + "description": "The JSON representation of the DeliveryMethod resource to be created or updated.", + "required": true, + "x-bodyName": "DeliveryMethod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55243,6 +68187,79 @@ "value" ], "type": "object" + }, + "EdFi_DescriptorMapping_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DescriptorMapping_TrackedChangeKey": { + "properties": { + "mappedNamespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "mappedValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "value": { + "maxLength": 50, + "type": "string" + } + }, + "required": [ + "mappedNamespace", + "mappedValue", + "namespace", + "value" + ], + "type": "object" + }, + "EdFi_DescriptorMapping_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -55345,7 +68362,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55388,7 +68405,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55408,27 +68425,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/descriptorMappings/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDescriptorMappingsById", + "/ed-fi/descriptorMappings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDescriptorMappingsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -55442,48 +68472,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "descriptorMappings" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/descriptorMappings/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDescriptorMappingsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDescriptorMappingsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -55491,14 +68510,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DescriptorMapping" + "items": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -55510,20 +68529,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "descriptorMappings" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDescriptorMapping", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/descriptorMappings/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDescriptorMappingsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -55538,18 +68561,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DescriptorMapping" - } - } - }, - "description": "The JSON representation of the DescriptorMapping resource to be created or updated.", - "required": true, - "x-bodyName": "DescriptorMapping" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -55567,7 +68578,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "descriptorMappings" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDescriptorMappingsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "descriptorMappings" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDescriptorMapping", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping" + } + } + }, + "description": "The JSON representation of the DescriptorMapping resource to be created or updated.", + "required": true, + "x-bodyName": "DescriptorMapping" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55780,6 +68906,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DiagnosisDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DiagnosisDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DiagnosisDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -55896,7 +69083,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55939,7 +69126,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55959,27 +69146,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/diagnosisDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDiagnosesById", + "/ed-fi/diagnosisDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDiagnosesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -55993,48 +69193,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "diagnosisDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diagnosisDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDiagnosesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDiagnosesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -56042,14 +69231,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -56061,20 +69250,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "diagnosisDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDiagnosis", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diagnosisDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDiagnosesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -56089,18 +69282,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor" - } - } - }, - "description": "The JSON representation of the Diagnosis resource to be created or updated.", - "required": true, - "x-bodyName": "Diagnosis" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -56118,7 +69299,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "diagnosisDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDiagnosesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "diagnosisDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDiagnosis", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor" + } + } + }, + "description": "The JSON representation of the Diagnosis resource to be created or updated.", + "required": true, + "x-bodyName": "Diagnosis" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56343,6 +69639,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DiplomaLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DiplomaLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DiplomaLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -56459,7 +69816,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56502,7 +69859,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56522,27 +69879,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/diplomaLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDiplomaLevelsById", + "/ed-fi/diplomaLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -56556,48 +69926,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "diplomaLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diplomaLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDiplomaLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -56605,14 +69964,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -56624,20 +69983,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "diplomaLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDiplomaLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diplomaLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDiplomaLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -56652,18 +70015,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor" - } - } - }, - "description": "The JSON representation of the DiplomaLevel resource to be created or updated.", - "required": true, - "x-bodyName": "DiplomaLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -56681,7 +70032,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "diplomaLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDiplomaLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "diplomaLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDiplomaLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor" + } + } + }, + "description": "The JSON representation of the DiplomaLevel resource to be created or updated.", + "required": true, + "x-bodyName": "DiplomaLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56906,6 +70372,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DiplomaTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DiplomaTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DiplomaTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -57022,7 +70549,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -57065,7 +70592,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -57085,27 +70612,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/diplomaTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDiplomaTypesById", + "/ed-fi/diplomaTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -57119,48 +70659,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "diplomaTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diplomaTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDiplomaTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -57168,14 +70697,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -57187,20 +70716,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "diplomaTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDiplomaType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diplomaTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDiplomaTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -57215,18 +70748,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor" - } - } - }, - "description": "The JSON representation of the DiplomaType resource to be created or updated.", - "required": true, - "x-bodyName": "DiplomaType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -57244,7 +70765,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "diplomaTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDiplomaTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "diplomaTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDiplomaType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor" + } + } + }, + "description": "The JSON representation of the DiplomaType resource to be created or updated.", + "required": true, + "x-bodyName": "DiplomaType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -57469,6 +71105,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -57585,7 +71282,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -57628,7 +71325,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -57648,27 +71345,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disabilityDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisabilitiesById", + "/ed-fi/disabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilitiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -57682,48 +71392,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disabilityDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisabilitiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilitiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -57731,14 +71430,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -57750,20 +71449,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disabilityDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisability", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisabilitiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -57778,18 +71481,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDescriptor" - } - } - }, - "description": "The JSON representation of the Disability resource to be created or updated.", - "required": true, - "x-bodyName": "Disability" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -57807,7 +71498,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disabilityDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisabilitiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disabilityDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisability", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor" + } + } + }, + "description": "The JSON representation of the Disability resource to be created or updated.", + "required": true, + "x-bodyName": "Disability" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -58032,6 +71838,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisabilityDesignationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisabilityDesignationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisabilityDesignationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -58148,7 +72015,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -58191,7 +72058,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -58211,27 +72078,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disabilityDesignationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisabilityDesignationsById", + "/ed-fi/disabilityDesignationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDesignationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -58245,48 +72125,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disabilityDesignationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDesignationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisabilityDesignationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDesignationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -58294,14 +72163,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -58313,20 +72182,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disabilityDesignationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisabilityDesignation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDesignationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisabilityDesignationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -58341,18 +72214,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor" - } - } - }, - "description": "The JSON representation of the DisabilityDesignation resource to be created or updated.", - "required": true, - "x-bodyName": "DisabilityDesignation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -58370,7 +72231,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disabilityDesignationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisabilityDesignationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disabilityDesignationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisabilityDesignation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor" + } + } + }, + "description": "The JSON representation of the DisabilityDesignation resource to be created or updated.", + "required": true, + "x-bodyName": "DisabilityDesignation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -58595,6 +72571,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -58711,7 +72748,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -58754,7 +72791,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -58774,27 +72811,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disabilityDeterminationSourceTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisabilityDeterminationSourceTypesById", + "/ed-fi/disabilityDeterminationSourceTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDeterminationSourceTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -58808,48 +72858,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disabilityDeterminationSourceTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDeterminationSourceTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisabilityDeterminationSourceTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDeterminationSourceTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -58857,14 +72896,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -58876,20 +72915,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disabilityDeterminationSourceTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisabilityDeterminationSourceType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDeterminationSourceTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisabilityDeterminationSourceTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -58904,18 +72947,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor" - } - } - }, - "description": "The JSON representation of the DisabilityDeterminationSourceType resource to be created or updated.", - "required": true, - "x-bodyName": "DisabilityDeterminationSourceType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -58933,7 +72964,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disabilityDeterminationSourceTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisabilityDeterminationSourceTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disabilityDeterminationSourceTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisabilityDeterminationSourceType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor" + } + } + }, + "description": "The JSON representation of the DisabilityDeterminationSourceType resource to be created or updated.", + "required": true, + "x-bodyName": "DisabilityDeterminationSourceType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -59158,6 +73304,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -59274,7 +73481,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59317,7 +73524,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -59337,27 +73544,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisciplineActionLengthDifferenceReasonsById", + "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionLengthDifferenceReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -59371,48 +73591,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disciplineActionLengthDifferenceReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisciplineActionLengthDifferenceReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionLengthDifferenceReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -59420,14 +73629,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -59439,20 +73648,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disciplineActionLengthDifferenceReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisciplineActionLengthDifferenceReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisciplineActionLengthDifferenceReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -59467,18 +73680,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor" - } - } - }, - "description": "The JSON representation of the DisciplineActionLengthDifferenceReason resource to be created or updated.", - "required": true, - "x-bodyName": "DisciplineActionLengthDifferenceReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -59496,7 +73697,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disciplineActionLengthDifferenceReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisciplineActionLengthDifferenceReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disciplineActionLengthDifferenceReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisciplineActionLengthDifferenceReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor" + } + } + }, + "description": "The JSON representation of the DisciplineActionLengthDifferenceReason resource to be created or updated.", + "required": true, + "x-bodyName": "DisciplineActionLengthDifferenceReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -60140,6 +74456,72 @@ "studentDisciplineIncidentBehaviorAssociationReference" ], "type": "object" + }, + "EdFi_DisciplineAction_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineAction_TrackedChangeKey": { + "properties": { + "disciplineActionIdentifier": { + "maxLength": 36, + "type": "string" + }, + "disciplineDate": { + "format": "date", + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "disciplineActionIdentifier", + "disciplineDate", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_DisciplineAction_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -60293,7 +74675,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -60336,7 +74718,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -60357,27 +74739,40 @@ "Discipline" ] }, - "/ed-fi/disciplineActions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisciplineActionsById", + "/ed-fi/disciplineActions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -60391,48 +74786,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disciplineActions" ] }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineActions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisciplineActionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -60440,14 +74825,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineAction" + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -60459,20 +74844,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disciplineActions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisciplineAction", + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineActions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisciplineActionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -60487,18 +74877,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineAction" - } - } - }, - "description": "The JSON representation of the DisciplineAction resource to be created or updated.", - "required": true, - "x-bodyName": "DisciplineAction" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -60516,7 +74894,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disciplineActions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisciplineActionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineAction" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disciplineActions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisciplineAction", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineAction" + } + } + }, + "description": "The JSON representation of the DisciplineAction resource to be created or updated.", + "required": true, + "x-bodyName": "DisciplineAction" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -60776,6 +75269,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisciplineDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisciplineDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -60892,7 +75446,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -60935,7 +75489,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -60955,27 +75509,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disciplineDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisciplinesById", + "/ed-fi/disciplineDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplinesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -60989,48 +75556,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disciplineDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisciplinesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplinesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -61038,14 +75594,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -61057,20 +75613,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disciplineDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDiscipline", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisciplinesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -61085,18 +75645,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineDescriptor" - } - } - }, - "description": "The JSON representation of the Discipline resource to be created or updated.", - "required": true, - "x-bodyName": "Discipline" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -61114,7 +75662,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disciplineDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisciplinesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disciplineDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDiscipline", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor" + } + } + }, + "description": "The JSON representation of the Discipline resource to be created or updated.", + "required": true, + "x-bodyName": "Discipline" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -61339,6 +76002,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -61455,7 +76179,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -61498,7 +76222,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -61518,27 +76242,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disciplineIncidentParticipationCodeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisciplineIncidentParticipationCodesById", + "/ed-fi/disciplineIncidentParticipationCodeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentParticipationCodesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -61552,48 +76289,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disciplineIncidentParticipationCodeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineIncidentParticipationCodeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisciplineIncidentParticipationCodesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentParticipationCodesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -61601,14 +76327,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -61620,20 +76346,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disciplineIncidentParticipationCodeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisciplineIncidentParticipationCode", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineIncidentParticipationCodeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisciplineIncidentParticipationCodesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -61648,18 +76378,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor" - } - } - }, - "description": "The JSON representation of the DisciplineIncidentParticipationCode resource to be created or updated.", - "required": true, - "x-bodyName": "DisciplineIncidentParticipationCode" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -61677,7 +76395,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disciplineIncidentParticipationCodeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisciplineIncidentParticipationCodesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disciplineIncidentParticipationCodeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisciplineIncidentParticipationCode", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor" + } + } + }, + "description": "The JSON representation of the DisciplineIncidentParticipationCode resource to be created or updated.", + "required": true, + "x-bodyName": "DisciplineIncidentParticipationCode" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62287,6 +77120,67 @@ ], "type": "object" }, + "EdFi_DisciplineIncident_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineIncident_TrackedChangeKey": { + "properties": { + "incidentIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "incidentIdentifier", + "schoolId" + ], + "type": "object" + }, + "EdFi_DisciplineIncident_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_DisciplineIncident_Weapon": { "properties": { "weaponDescriptor": { @@ -62458,7 +77352,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62501,7 +77395,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62522,27 +77416,40 @@ "Discipline" ] }, - "/ed-fi/disciplineIncidents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisciplineIncidentsById", + "/ed-fi/disciplineIncidents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -62556,48 +77463,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disciplineIncidents" ] }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineIncidents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisciplineIncidentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -62605,14 +77502,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineIncident" + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -62624,20 +77521,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disciplineIncidents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisciplineIncident", + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineIncidents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisciplineIncidentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -62652,18 +77554,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineIncident" - } - } - }, - "description": "The JSON representation of the DisciplineIncident resource to be created or updated.", - "required": true, - "x-bodyName": "DisciplineIncident" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -62681,7 +77571,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disciplineIncidents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisciplineIncidentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disciplineIncidents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisciplineIncident", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident" + } + } + }, + "description": "The JSON representation of the DisciplineIncident resource to be created or updated.", + "required": true, + "x-bodyName": "DisciplineIncident" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62945,6 +77950,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisplacedStudentStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -63061,7 +78127,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63104,7 +78170,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63124,27 +78190,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/displacedStudentStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisplacedStudentStatusesById", + "/ed-fi/displacedStudentStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisplacedStudentStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -63158,48 +78237,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "displacedStudentStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/displacedStudentStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisplacedStudentStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisplacedStudentStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -63207,14 +78275,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -63226,20 +78294,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "displacedStudentStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisplacedStudentStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/displacedStudentStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisplacedStudentStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -63254,18 +78326,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor" - } - } - }, - "description": "The JSON representation of the DisplacedStudentStatus resource to be created or updated.", - "required": true, - "x-bodyName": "DisplacedStudentStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -63283,7 +78343,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "displacedStudentStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisplacedStudentStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "displacedStudentStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisplacedStudentStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor" + } + } + }, + "description": "The JSON representation of the DisplacedStudentStatus resource to be created or updated.", + "required": true, + "x-bodyName": "DisplacedStudentStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -64147,6 +79322,62 @@ "contentIdentifier" ], "type": "object" + }, + "EdFi_EducationContent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationContent_TrackedChangeKey": { + "properties": { + "contentIdentifier": { + "maxLength": 225, + "type": "string" + } + }, + "required": [ + "contentIdentifier" + ], + "type": "object" + }, + "EdFi_EducationContent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -64364,7 +79595,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -64407,7 +79638,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -64428,27 +79659,40 @@ "Intervention" ] }, - "/ed-fi/educationContents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationContentsById", + "/ed-fi/educationContents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationContentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -64462,48 +79706,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationContents" ] }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/educationContents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationContentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationContentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -64511,14 +79745,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationContent" + "items": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -64530,20 +79764,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationContents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationContent", + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/educationContents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationContentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -64558,18 +79797,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationContent" - } - } - }, - "description": "The JSON representation of the EducationContent resource to be created or updated.", - "required": true, - "x-bodyName": "EducationContent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -64587,7 +79814,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationContents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationContentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationContent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationContents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationContent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationContent" + } + } + }, + "description": "The JSON representation of the EducationContent resource to be created or updated.", + "required": true, + "x-bodyName": "EducationContent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -64884,6 +80226,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -65000,7 +80403,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -65043,7 +80446,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -65063,27 +80466,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationOrganizationAssociationTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationAssociationTypesById", + "/ed-fi/educationOrganizationAssociationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationAssociationTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -65097,48 +80513,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationAssociationTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationAssociationTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationAssociationTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationAssociationTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -65146,14 +80551,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -65165,20 +80570,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationAssociationTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationAssociationType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationAssociationTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationAssociationTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -65193,18 +80602,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor" - } - } - }, - "description": "The JSON representation of the EducationOrganizationAssociationType resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationAssociationType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -65222,7 +80619,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationAssociationTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationAssociationTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationAssociationTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationAssociationType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor" + } + } + }, + "description": "The JSON representation of the EducationOrganizationAssociationType resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationAssociationType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -65447,6 +80959,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -65563,7 +81136,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -65606,7 +81179,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -65626,27 +81199,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationOrganizationCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationCategoriesById", + "/ed-fi/educationOrganizationCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -65660,48 +81246,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -65709,14 +81284,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -65728,20 +81303,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -65756,18 +81335,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the EducationOrganizationCategory resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -65785,7 +81352,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the EducationOrganizationCategory resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66010,6 +81692,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -66126,7 +81869,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66169,7 +81912,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66189,27 +81932,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationOrganizationIdentificationSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationIdentificationSystemsById", + "/ed-fi/educationOrganizationIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationIdentificationSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -66223,48 +81979,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationIdentificationSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationIdentificationSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationIdentificationSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationIdentificationSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -66272,14 +82017,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -66291,20 +82036,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationIdentificationSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationIdentificationSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationIdentificationSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationIdentificationSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -66319,18 +82068,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor" - } - } - }, - "description": "The JSON representation of the EducationOrganizationIdentificationSystem resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationIdentificationSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -66348,7 +82085,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationIdentificationSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationIdentificationSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationIdentificationSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationIdentificationSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor" + } + } + }, + "description": "The JSON representation of the EducationOrganizationIdentificationSystem resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationIdentificationSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66644,6 +82496,72 @@ "interventionPrescriptionIdentificationCode" ], "type": "object" + }, + "EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionPrescriptionEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionPrescriptionIdentificationCode": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionPrescriptionEducationOrganizationId", + "interventionPrescriptionIdentificationCode" + ], + "type": "object" + }, + "EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -66752,7 +82670,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66795,7 +82713,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66816,27 +82734,40 @@ "Intervention" ] }, - "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationInterventionPrescriptionAssociationsById", + "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -66850,48 +82781,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationInterventionPrescriptionAssociations" ] }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -66899,14 +82820,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -66918,20 +82839,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationInterventionPrescriptionAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationInterventionPrescriptionAssociation", + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationInterventionPrescriptionAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -66946,18 +82872,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation" - } - } - }, - "description": "The JSON representation of the EducationOrganizationInterventionPrescriptionAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationInterventionPrescriptionAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -66975,7 +82889,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationInterventionPrescriptionAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationInterventionPrescriptionAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationInterventionPrescriptionAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation" + } + } + }, + "description": "The JSON representation of the EducationOrganizationInterventionPrescriptionAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationInterventionPrescriptionAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67254,6 +83283,67 @@ "memberEducationOrganizationId" ], "type": "object" + }, + "EdFi_EducationOrganizationNetworkAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationNetworkId": { + "format": "int64", + "type": "integer" + }, + "memberEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationOrganizationNetworkId", + "memberEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -67352,7 +83442,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67395,7 +83485,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67416,27 +83506,40 @@ "EducationOrganization" ] }, - "/ed-fi/educationOrganizationNetworkAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationNetworkAssociationsById", + "/ed-fi/educationOrganizationNetworkAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworkAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -67450,48 +83553,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationNetworkAssociations" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationNetworkAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationNetworkAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworkAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -67499,14 +83592,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -67518,20 +83611,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationNetworkAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationNetworkAssociation", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationNetworkAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationNetworkAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -67546,18 +83644,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation" - } - } - }, - "description": "The JSON representation of the EducationOrganizationNetworkAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationNetworkAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -67575,7 +83661,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationNetworkAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationNetworkAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationNetworkAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationNetworkAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation" + } + } + }, + "description": "The JSON representation of the EducationOrganizationNetworkAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationNetworkAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68576,6 +84777,62 @@ ], "type": "object" }, + "EdFi_EducationOrganizationNetwork_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetwork_TrackedChangeKey": { + "properties": { + "educationOrganizationNetworkId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationOrganizationNetworkId" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetwork_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_EducationOrganization_Address": { "properties": { "addressTypeDescriptor": { @@ -68973,7 +85230,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69016,7 +85273,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69037,27 +85294,40 @@ "EducationOrganization" ] }, - "/ed-fi/educationOrganizationNetworks/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationNetworksById", + "/ed-fi/educationOrganizationNetworks/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworksDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -69071,48 +85341,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationNetworks" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationNetworks/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationNetworksById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworksKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -69120,14 +85380,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -69139,20 +85399,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationNetworks" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationNetwork", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationNetworks/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationNetworksById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -69167,18 +85432,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork" - } - } - }, - "description": "The JSON representation of the EducationOrganizationNetwork resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationNetwork" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -69196,7 +85449,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationNetworks" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationNetworksById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationNetworks" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationNetwork", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork" + } + } + }, + "description": "The JSON representation of the EducationOrganizationNetwork resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationNetwork" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69448,6 +85816,67 @@ "peerEducationOrganizationId" ], "type": "object" + }, + "EdFi_EducationOrganizationPeerAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "peerEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationOrganizationId", + "peerEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_EducationOrganizationPeerAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -69528,7 +85957,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69571,7 +86000,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69591,27 +86020,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationOrganizationPeerAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationPeerAssociationsById", + "/ed-fi/educationOrganizationPeerAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationPeerAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -69625,48 +86067,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationPeerAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationPeerAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationPeerAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationPeerAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -69674,14 +86105,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -69693,20 +86124,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationPeerAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationPeerAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationPeerAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationPeerAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -69721,18 +86156,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation" - } - } - }, - "description": "The JSON representation of the EducationOrganizationPeerAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationPeerAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -69750,7 +86173,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationPeerAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationPeerAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationPeerAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationPeerAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation" + } + } + }, + "description": "The JSON representation of the EducationOrganizationPeerAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationPeerAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69959,6 +86497,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationPlanDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationPlanDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationPlanDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -70075,7 +86674,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70118,7 +86717,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70138,27 +86737,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationPlanDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationPlansById", + "/ed-fi/educationPlanDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationPlansDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -70172,48 +86784,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationPlanDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationPlanDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationPlansById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationPlansKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -70221,14 +86822,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -70240,20 +86841,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationPlanDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationPlan", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationPlanDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationPlansById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -70268,18 +86873,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor" - } - } - }, - "description": "The JSON representation of the EducationPlan resource to be created or updated.", - "required": true, - "x-bodyName": "EducationPlan" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -70297,7 +86890,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationPlanDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationPlansById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationPlanDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationPlan", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor" + } + } + }, + "description": "The JSON representation of the EducationPlan resource to be created or updated.", + "required": true, + "x-bodyName": "EducationPlan" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -71595,6 +88303,62 @@ "educationServiceCenterId" ], "type": "object" + }, + "EdFi_EducationServiceCenter_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationServiceCenter_TrackedChangeKey": { + "properties": { + "educationServiceCenterId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationServiceCenterId" + ], + "type": "object" + }, + "EdFi_EducationServiceCenter_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -71712,7 +88476,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71755,7 +88519,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -71777,27 +88541,40 @@ "Staff" ] }, - "/ed-fi/educationServiceCenters/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationServiceCentersById", + "/ed-fi/educationServiceCenters/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationServiceCentersDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -71811,48 +88588,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationServiceCenters" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, + "/ed-fi/educationServiceCenters/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationServiceCentersById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationServiceCentersKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -71860,14 +88628,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationServiceCenter" + "items": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -71879,20 +88647,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationServiceCenters" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationServiceCenter", + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, + "/ed-fi/educationServiceCenters/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationServiceCentersById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -71907,18 +88681,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationServiceCenter" - } - } - }, - "description": "The JSON representation of the EducationServiceCenter resource to be created or updated.", - "required": true, - "x-bodyName": "EducationServiceCenter" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -71936,7 +88698,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationServiceCenters" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationServiceCentersById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationServiceCenters" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationServiceCenter", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter" + } + } + }, + "description": "The JSON representation of the EducationServiceCenter resource to be created or updated.", + "required": true, + "x-bodyName": "EducationServiceCenter" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72177,6 +89054,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationalEnvironmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationalEnvironmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -72293,7 +89231,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72336,7 +89274,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72356,27 +89294,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationalEnvironmentDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationalEnvironmentsById", + "/ed-fi/educationalEnvironmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationalEnvironmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -72390,48 +89341,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationalEnvironmentDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationalEnvironmentDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationalEnvironmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationalEnvironmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -72439,14 +89379,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -72458,20 +89398,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationalEnvironmentDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationalEnvironment", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationalEnvironmentDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationalEnvironmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -72486,18 +89430,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor" - } - } - }, - "description": "The JSON representation of the EducationalEnvironment resource to be created or updated.", - "required": true, - "x-bodyName": "EducationalEnvironment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -72515,7 +89447,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationalEnvironmentDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationalEnvironmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationalEnvironmentDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationalEnvironment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor" + } + } + }, + "description": "The JSON representation of the EducationalEnvironment resource to be created or updated.", + "required": true, + "x-bodyName": "EducationalEnvironment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72740,6 +89787,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ElectronicMailTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ElectronicMailTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -72856,7 +89964,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72899,7 +90007,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72919,27 +90027,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/electronicMailTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteElectronicMailTypesById", + "/ed-fi/electronicMailTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getElectronicMailTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -72953,48 +90074,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "electronicMailTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/electronicMailTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getElectronicMailTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getElectronicMailTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -73002,14 +90112,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -73021,20 +90131,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "electronicMailTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putElectronicMailType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/electronicMailTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteElectronicMailTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -73049,18 +90163,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ElectronicMailType resource to be created or updated.", - "required": true, - "x-bodyName": "ElectronicMailType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -73078,7 +90180,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "electronicMailTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getElectronicMailTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "electronicMailTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putElectronicMailType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ElectronicMailType resource to be created or updated.", + "required": true, + "x-bodyName": "ElectronicMailType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -73303,6 +90520,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EligibilityDelayReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -73419,7 +90697,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73462,7 +90740,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -73482,27 +90760,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/eligibilityDelayReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEligibilityDelayReasonsById", + "/ed-fi/eligibilityDelayReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityDelayReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -73516,48 +90807,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "eligibilityDelayReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eligibilityDelayReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEligibilityDelayReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityDelayReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -73565,14 +90845,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -73584,20 +90864,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "eligibilityDelayReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEligibilityDelayReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eligibilityDelayReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEligibilityDelayReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -73612,18 +90896,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor" - } - } - }, - "description": "The JSON representation of the EligibilityDelayReason resource to be created or updated.", - "required": true, - "x-bodyName": "EligibilityDelayReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -73641,7 +90913,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "eligibilityDelayReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEligibilityDelayReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "eligibilityDelayReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEligibilityDelayReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor" + } + } + }, + "description": "The JSON representation of the EligibilityDelayReason resource to be created or updated.", + "required": true, + "x-bodyName": "EligibilityDelayReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -73866,6 +91253,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -73982,7 +91430,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -74025,7 +91473,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -74045,27 +91493,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/eligibilityEvaluationTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEligibilityEvaluationTypesById", + "/ed-fi/eligibilityEvaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityEvaluationTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -74079,48 +91540,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "eligibilityEvaluationTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eligibilityEvaluationTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEligibilityEvaluationTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityEvaluationTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -74128,14 +91578,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -74147,20 +91597,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "eligibilityEvaluationTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEligibilityEvaluationType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eligibilityEvaluationTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEligibilityEvaluationTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -74175,18 +91629,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor" - } - } - }, - "description": "The JSON representation of the EligibilityEvaluationType resource to be created or updated.", - "required": true, - "x-bodyName": "EligibilityEvaluationType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -74204,7 +91646,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "eligibilityEvaluationTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEligibilityEvaluationTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "eligibilityEvaluationTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEligibilityEvaluationType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor" + } + } + }, + "description": "The JSON representation of the EligibilityEvaluationType resource to be created or updated.", + "required": true, + "x-bodyName": "EligibilityEvaluationType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -74429,6 +91986,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EmploymentStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EmploymentStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EmploymentStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -74545,7 +92163,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -74588,7 +92206,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -74608,27 +92226,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/employmentStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEmploymentStatusesById", + "/ed-fi/employmentStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEmploymentStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -74642,48 +92273,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "employmentStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/employmentStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEmploymentStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEmploymentStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -74691,14 +92311,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -74710,20 +92330,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "employmentStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEmploymentStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/employmentStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEmploymentStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -74738,18 +92362,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor" - } - } - }, - "description": "The JSON representation of the EmploymentStatus resource to be created or updated.", - "required": true, - "x-bodyName": "EmploymentStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -74767,7 +92379,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "employmentStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEmploymentStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "employmentStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEmploymentStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor" + } + } + }, + "description": "The JSON representation of the EmploymentStatus resource to be created or updated.", + "required": true, + "x-bodyName": "EmploymentStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -74992,6 +92719,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EnrollmentTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EnrollmentTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EnrollmentTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -75108,7 +92896,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -75151,7 +92939,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -75171,27 +92959,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/enrollmentTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEnrollmentTypesById", + "/ed-fi/enrollmentTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEnrollmentTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -75205,48 +93006,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "enrollmentTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/enrollmentTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEnrollmentTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEnrollmentTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -75254,14 +93044,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -75273,20 +93063,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "enrollmentTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEnrollmentType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/enrollmentTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEnrollmentTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -75301,18 +93095,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor" - } - } - }, - "description": "The JSON representation of the EnrollmentType resource to be created or updated.", - "required": true, - "x-bodyName": "EnrollmentType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -75330,7 +93112,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "enrollmentTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEnrollmentTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "enrollmentTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEnrollmentType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor" + } + } + }, + "description": "The JSON representation of the EnrollmentType resource to be created or updated.", + "required": true, + "x-bodyName": "EnrollmentType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -75555,6 +93452,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -75671,7 +93629,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -75714,7 +93672,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -75734,27 +93692,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/entryGradeLevelReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEntryGradeLevelReasonsById", + "/ed-fi/entryGradeLevelReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEntryGradeLevelReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -75768,48 +93739,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "entryGradeLevelReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/entryGradeLevelReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEntryGradeLevelReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEntryGradeLevelReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -75817,14 +93777,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -75836,20 +93796,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "entryGradeLevelReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEntryGradeLevelReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/entryGradeLevelReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEntryGradeLevelReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -75864,18 +93828,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor" - } - } - }, - "description": "The JSON representation of the EntryGradeLevelReason resource to be created or updated.", - "required": true, - "x-bodyName": "EntryGradeLevelReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -75893,7 +93845,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "entryGradeLevelReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEntryGradeLevelReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "entryGradeLevelReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEntryGradeLevelReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor" + } + } + }, + "description": "The JSON representation of the EntryGradeLevelReason resource to be created or updated.", + "required": true, + "x-bodyName": "EntryGradeLevelReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76118,6 +94185,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EntryTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EntryTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EntryTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -76234,7 +94362,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -76277,7 +94405,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76297,27 +94425,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/entryTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEntryTypesById", + "/ed-fi/entryTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEntryTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -76331,48 +94472,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "entryTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/entryTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEntryTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEntryTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -76380,14 +94510,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -76399,20 +94529,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "entryTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEntryType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/entryTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEntryTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -76427,18 +94561,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor" - } - } - }, - "description": "The JSON representation of the EntryType resource to be created or updated.", - "required": true, - "x-bodyName": "EntryType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -76456,7 +94578,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "entryTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEntryTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "entryTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEntryType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor" + } + } + }, + "description": "The JSON representation of the EntryType resource to be created or updated.", + "required": true, + "x-bodyName": "EntryType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76681,6 +94918,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EvaluationDelayReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -76797,7 +95095,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -76840,7 +95138,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76860,27 +95158,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/evaluationDelayReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEvaluationDelayReasonsById", + "/ed-fi/evaluationDelayReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationDelayReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -76894,48 +95205,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationDelayReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/evaluationDelayReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEvaluationDelayReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationDelayReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -76943,14 +95243,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -76962,20 +95262,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationDelayReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEvaluationDelayReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/evaluationDelayReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEvaluationDelayReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -76990,18 +95294,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor" - } - } - }, - "description": "The JSON representation of the EvaluationDelayReason resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationDelayReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -77019,7 +95311,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "evaluationDelayReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEvaluationDelayReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "evaluationDelayReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEvaluationDelayReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor" + } + } + }, + "description": "The JSON representation of the EvaluationDelayReason resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationDelayReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77419,6 +95826,97 @@ "programEvaluationElementTitle" ], "type": "object" + }, + "EdFi_EvaluationRubricDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationRubricDimension_TrackedChangeKey": { + "properties": { + "evaluationRubricRating": { + "format": "int32", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationElementTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "evaluationRubricRating", + "programEducationOrganizationId", + "programEvaluationElementTitle", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_EvaluationRubricDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -77586,7 +96084,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77629,7 +96127,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77650,27 +96148,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/evaluationRubricDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEvaluationRubricDimensionsById", + "/ed-fi/evaluationRubricDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRubricDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -77684,48 +96195,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationRubricDimensions" ] }, + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/evaluationRubricDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEvaluationRubricDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRubricDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -77733,14 +96234,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension" + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -77752,20 +96253,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationRubricDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEvaluationRubricDimension", + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/evaluationRubricDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEvaluationRubricDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -77780,18 +96286,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension" - } - } - }, - "description": "The JSON representation of the EvaluationRubricDimension resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationRubricDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -77809,7 +96303,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "evaluationRubricDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEvaluationRubricDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "evaluationRubricDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEvaluationRubricDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension" + } + } + }, + "description": "The JSON representation of the EvaluationRubricDimension resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationRubricDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78068,6 +96677,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EventCircumstanceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EventCircumstanceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EventCircumstanceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -78184,7 +96854,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78227,7 +96897,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78247,27 +96917,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/eventCircumstanceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEventCircumstancesById", + "/ed-fi/eventCircumstanceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEventCircumstancesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -78281,48 +96964,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "eventCircumstanceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eventCircumstanceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEventCircumstancesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEventCircumstancesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -78330,14 +97002,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -78349,20 +97021,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "eventCircumstanceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEventCircumstance", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eventCircumstanceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEventCircumstancesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -78377,18 +97053,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor" - } - } - }, - "description": "The JSON representation of the EventCircumstance resource to be created or updated.", - "required": true, - "x-bodyName": "EventCircumstance" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -78406,7 +97070,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "eventCircumstanceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEventCircumstancesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "eventCircumstanceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEventCircumstance", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor" + } + } + }, + "description": "The JSON representation of the EventCircumstance resource to be created or updated.", + "required": true, + "x-bodyName": "EventCircumstance" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78631,6 +97410,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ExitWithdrawTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -78747,7 +97587,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78790,7 +97630,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78810,27 +97650,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/exitWithdrawTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteExitWithdrawTypesById", + "/ed-fi/exitWithdrawTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getExitWithdrawTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -78844,48 +97697,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "exitWithdrawTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/exitWithdrawTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getExitWithdrawTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getExitWithdrawTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -78893,14 +97735,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -78912,20 +97754,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "exitWithdrawTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putExitWithdrawType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/exitWithdrawTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteExitWithdrawTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -78940,18 +97786,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ExitWithdrawType resource to be created or updated.", - "required": true, - "x-bodyName": "ExitWithdrawType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -78969,7 +97803,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "exitWithdrawTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getExitWithdrawTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "exitWithdrawTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putExitWithdrawType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ExitWithdrawType resource to be created or updated.", + "required": true, + "x-bodyName": "ExitWithdrawType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79273,6 +98222,72 @@ "schoolId" ], "type": "object" + }, + "EdFi_FeederSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FeederSchoolAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "feederSchoolId": { + "format": "int64", + "type": "integer" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "beginDate", + "feederSchoolId", + "schoolId" + ], + "type": "object" + }, + "EdFi_FeederSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -79381,7 +98396,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79424,7 +98439,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79445,27 +98460,40 @@ "EducationOrganization" ] }, - "/ed-fi/feederSchoolAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteFeederSchoolAssociationsById", + "/ed-fi/feederSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFeederSchoolAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -79479,48 +98507,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "feederSchoolAssociations" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/feederSchoolAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getFeederSchoolAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFeederSchoolAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -79528,14 +98546,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -79547,20 +98565,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "feederSchoolAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putFeederSchoolAssociation", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/feederSchoolAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteFeederSchoolAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -79575,18 +98598,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation" - } - } - }, - "description": "The JSON representation of the FeederSchoolAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "FeederSchoolAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -79604,7 +98615,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "feederSchoolAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getFeederSchoolAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "feederSchoolAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putFeederSchoolAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation" + } + } + }, + "description": "The JSON representation of the FeederSchoolAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "FeederSchoolAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79832,6 +98958,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_FinancialCollectionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FinancialCollectionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_FinancialCollectionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -79948,7 +99135,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79991,7 +99178,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -80011,27 +99198,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/financialCollectionDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteFinancialCollectionsById", + "/ed-fi/financialCollectionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFinancialCollectionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -80045,48 +99245,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "financialCollectionDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/financialCollectionDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getFinancialCollectionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFinancialCollectionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -80094,14 +99283,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -80113,20 +99302,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "financialCollectionDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putFinancialCollection", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/financialCollectionDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteFinancialCollectionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -80141,18 +99334,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor" - } - } - }, - "description": "The JSON representation of the FinancialCollection resource to be created or updated.", - "required": true, - "x-bodyName": "FinancialCollection" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -80170,7 +99351,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "financialCollectionDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getFinancialCollectionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "financialCollectionDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putFinancialCollection", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor" + } + } + }, + "description": "The JSON representation of the FinancialCollection resource to be created or updated.", + "required": true, + "x-bodyName": "FinancialCollection" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -80457,6 +99753,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_FunctionDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FunctionDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_FunctionDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -80546,7 +99903,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80589,7 +99946,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -80610,27 +99967,40 @@ "Finance" ] }, - "/ed-fi/functionDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteFunctionDimensionsById", + "/ed-fi/functionDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFunctionDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -80644,48 +100014,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "functionDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/functionDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getFunctionDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFunctionDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -80693,14 +100053,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_FunctionDimension" + "items": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -80712,20 +100072,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "functionDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putFunctionDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/functionDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteFunctionDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -80740,18 +100105,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_FunctionDimension" - } - } - }, - "description": "The JSON representation of the FunctionDimension resource to be created or updated.", - "required": true, - "x-bodyName": "FunctionDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -80769,7 +100122,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "functionDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getFunctionDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FunctionDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "functionDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putFunctionDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FunctionDimension" + } + } + }, + "description": "The JSON representation of the FunctionDimension resource to be created or updated.", + "required": true, + "x-bodyName": "FunctionDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81038,6 +100506,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_FundDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FundDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_FundDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -81127,7 +100656,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81170,7 +100699,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81191,27 +100720,40 @@ "Finance" ] }, - "/ed-fi/fundDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteFundDimensionsById", + "/ed-fi/fundDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFundDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -81225,48 +100767,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "fundDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/fundDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getFundDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFundDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -81274,14 +100806,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_FundDimension" + "items": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -81293,20 +100825,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "fundDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putFundDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/fundDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteFundDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -81321,18 +100858,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_FundDimension" - } - } - }, - "description": "The JSON representation of the FundDimension resource to be created or updated.", - "required": true, - "x-bodyName": "FundDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -81350,7 +100875,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "fundDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getFundDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FundDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "fundDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putFundDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FundDimension" + } + } + }, + "description": "The JSON representation of the FundDimension resource to be created or updated.", + "required": true, + "x-bodyName": "FundDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81557,6 +101197,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradeLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradeLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradeLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -81673,7 +101374,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81716,7 +101417,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81736,27 +101437,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gradeLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradeLevelsById", + "/ed-fi/gradeLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradeLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -81770,48 +101484,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradeLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradeLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradeLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradeLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -81819,14 +101522,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -81838,20 +101541,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradeLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradeLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradeLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradeLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -81866,18 +101573,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor" - } - } - }, - "description": "The JSON representation of the GradeLevel resource to be created or updated.", - "required": true, - "x-bodyName": "GradeLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -81895,7 +101590,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradeLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradeLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradeLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradeLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor" + } + } + }, + "description": "The JSON representation of the GradeLevel resource to be created or updated.", + "required": true, + "x-bodyName": "GradeLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82120,6 +101930,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradePointAverageTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradePointAverageTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -82236,7 +102107,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82279,7 +102150,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82299,27 +102170,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gradePointAverageTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradePointAverageTypesById", + "/ed-fi/gradePointAverageTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradePointAverageTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -82333,48 +102217,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradePointAverageTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradePointAverageTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradePointAverageTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradePointAverageTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -82382,14 +102255,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -82401,20 +102274,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradePointAverageTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradePointAverageType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradePointAverageTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradePointAverageTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -82429,18 +102306,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor" - } - } - }, - "description": "The JSON representation of the GradePointAverageType resource to be created or updated.", - "required": true, - "x-bodyName": "GradePointAverageType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -82458,7 +102323,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradePointAverageTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradePointAverageTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradePointAverageTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradePointAverageType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor" + } + } + }, + "description": "The JSON representation of the GradePointAverageType resource to be created or updated.", + "required": true, + "x-bodyName": "GradePointAverageType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82683,6 +102663,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradeTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradeTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradeTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -82799,7 +102840,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82842,7 +102883,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82862,27 +102903,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gradeTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradeTypesById", + "/ed-fi/gradeTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradeTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -82896,48 +102950,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradeTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradeTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradeTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradeTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -82945,14 +102988,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -82964,20 +103007,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradeTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradeType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradeTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradeTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -82992,18 +103039,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor" - } - } - }, - "description": "The JSON representation of the GradeType resource to be created or updated.", - "required": true, - "x-bodyName": "GradeType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -83021,7 +103056,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradeTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradeTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradeTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradeType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor" + } + } + }, + "description": "The JSON representation of the GradeType resource to be created or updated.", + "required": true, + "x-bodyName": "GradeType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83616,6 +103766,68 @@ "namespace" ], "type": "object" + }, + "EdFi_GradebookEntry_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradebookEntry_TrackedChangeKey": { + "properties": { + "gradebookEntryIdentifier": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "gradebookEntryIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_GradebookEntry_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -83838,7 +104050,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83881,7 +104093,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83903,27 +104115,40 @@ "Gradebook" ] }, - "/ed-fi/gradebookEntries/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradebookEntriesById", + "/ed-fi/gradebookEntries/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -83937,48 +104162,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradebookEntries" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/gradebookEntries/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradebookEntriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -83986,14 +104202,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradebookEntry" + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -84005,20 +104221,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradebookEntries" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradebookEntry", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/gradebookEntries/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradebookEntriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -84033,18 +104255,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradebookEntry" - } - } - }, - "description": "The JSON representation of the GradebookEntry resource to be created or updated.", - "required": true, - "x-bodyName": "GradebookEntry" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -84062,7 +104272,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradebookEntries" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradebookEntriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradebookEntry" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradebookEntries" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradebookEntry", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradebookEntry" + } + } + }, + "description": "The JSON representation of the GradebookEntry resource to be created or updated.", + "required": true, + "x-bodyName": "GradebookEntry" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84356,6 +104681,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradebookEntryTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradebookEntryTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -84472,7 +104858,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84515,7 +104901,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84535,27 +104921,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gradebookEntryTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradebookEntryTypesById", + "/ed-fi/gradebookEntryTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntryTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -84569,48 +104968,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradebookEntryTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradebookEntryTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradebookEntryTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntryTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -84618,14 +105006,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -84637,20 +105025,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradebookEntryTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradebookEntryType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradebookEntryTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradebookEntryTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -84665,18 +105057,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor" - } - } - }, - "description": "The JSON representation of the GradebookEntryType resource to be created or updated.", - "required": true, - "x-bodyName": "GradebookEntryType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -84694,7 +105074,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradebookEntryTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradebookEntryTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradebookEntryTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradebookEntryType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor" + } + } + }, + "description": "The JSON representation of the GradebookEntryType resource to be created or updated.", + "required": true, + "x-bodyName": "GradebookEntryType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85432,6 +105927,112 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_Grade_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Grade_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "gradeTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "type": "string" + }, + "gradingPeriodSchoolYear": { + "format": "int32", + "type": "integer" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "gradeTypeDescriptor", + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolYear", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_Grade_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -85664,7 +106265,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85707,7 +106308,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85729,27 +106330,40 @@ "ReportCard" ] }, - "/ed-fi/grades/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradesById", + "/ed-fi/grades/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -85763,48 +106377,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "grades" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/grades/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -85812,14 +106417,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Grade" + "items": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -85831,20 +106436,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "grades" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGrade", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/grades/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -85859,18 +106470,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Grade" - } - } - }, - "description": "The JSON representation of the Grade resource to be created or updated.", - "required": true, - "x-bodyName": "Grade" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -85888,7 +106487,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "grades" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Grade" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "grades" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGrade", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Grade" + } + } + }, + "description": "The JSON representation of the Grade resource to be created or updated.", + "required": true, + "x-bodyName": "Grade" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86197,6 +106911,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradingPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradingPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradingPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -86313,7 +107088,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86356,7 +107131,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86376,27 +107151,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gradingPeriodDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradingPeriodsById", + "/ed-fi/gradingPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -86410,48 +107198,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradingPeriodDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradingPeriodDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradingPeriodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -86459,14 +107236,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -86478,20 +107255,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradingPeriodDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradingPeriod", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradingPeriodDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradingPeriodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -86506,18 +107287,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor" - } - } - }, - "description": "The JSON representation of the GradingPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "GradingPeriod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -86535,7 +107304,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradingPeriodDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradingPeriodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradingPeriodDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradingPeriod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor" + } + } + }, + "description": "The JSON representation of the GradingPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "GradingPeriod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86919,6 +107803,77 @@ "schoolYear" ], "type": "object" + }, + "EdFi_GradingPeriod_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradingPeriod_TrackedChangeKey": { + "properties": { + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "gradingPeriodDescriptor", + "gradingPeriodName", + "schoolId", + "schoolYear" + ], + "type": "object" + }, + "EdFi_GradingPeriod_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -87055,7 +108010,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87098,7 +108053,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87121,27 +108076,40 @@ "ReportCard" ] }, - "/ed-fi/gradingPeriods/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradingPeriodsById", + "/ed-fi/gradingPeriods/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -87155,48 +108123,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradingPeriods" ] }, + "x-Ed-Fi-domains": [ + "SchoolCalendar", + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/gradingPeriods/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradingPeriodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -87204,14 +108164,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradingPeriod" + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -87223,20 +108183,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradingPeriods" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradingPeriod", + "x-Ed-Fi-domains": [ + "SchoolCalendar", + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/gradingPeriods/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradingPeriodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -87251,18 +108218,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradingPeriod" - } - } - }, - "description": "The JSON representation of the GradingPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "GradingPeriod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -87280,7 +108235,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradingPeriods" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradingPeriodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradingPeriod" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradingPeriods" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradingPeriod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradingPeriod" + } + } + }, + "description": "The JSON representation of the GradingPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "GradingPeriod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87523,6 +108593,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GraduationPlanTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GraduationPlanTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -87639,7 +108770,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87682,7 +108813,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87702,27 +108833,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/graduationPlanTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGraduationPlanTypesById", + "/ed-fi/graduationPlanTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlanTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -87736,48 +108880,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "graduationPlanTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/graduationPlanTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGraduationPlanTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlanTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -87785,14 +108918,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -87804,20 +108937,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "graduationPlanTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGraduationPlanType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/graduationPlanTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGraduationPlanTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -87832,18 +108969,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor" - } - } - }, - "description": "The JSON representation of the GraduationPlanType resource to be created or updated.", - "required": true, - "x-bodyName": "GraduationPlanType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -87861,7 +108986,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "graduationPlanTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGraduationPlanTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "graduationPlanTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGraduationPlanType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor" + } + } + }, + "description": "The JSON representation of the GraduationPlanType resource to be created or updated.", + "required": true, + "x-bodyName": "GraduationPlanType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89018,6 +110258,72 @@ "assessmentReportingMethodDescriptor" ], "type": "object" + }, + "EdFi_GraduationPlan_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GraduationPlan_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "graduationPlanTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "graduationSchoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "educationOrganizationId", + "graduationPlanTypeDescriptor", + "graduationSchoolYear" + ], + "type": "object" + }, + "EdFi_GraduationPlan_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -89143,7 +110449,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89186,7 +110492,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89208,27 +110514,40 @@ "Graduation" ] }, - "/ed-fi/graduationPlans/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGraduationPlansById", + "/ed-fi/graduationPlans/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlansDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -89242,48 +110561,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "graduationPlans" ] }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation" + ] + }, + "/ed-fi/graduationPlans/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGraduationPlansById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlansKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -89291,14 +110601,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GraduationPlan" + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -89310,20 +110620,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "graduationPlans" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGraduationPlan", + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation" + ] + }, + "/ed-fi/graduationPlans/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGraduationPlansById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -89338,18 +110654,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GraduationPlan" - } - } - }, - "description": "The JSON representation of the GraduationPlan resource to be created or updated.", - "required": true, - "x-bodyName": "GraduationPlan" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -89367,7 +110671,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "graduationPlans" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGraduationPlansById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GraduationPlan" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "graduationPlans" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGraduationPlan", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GraduationPlan" + } + } + }, + "description": "The JSON representation of the GraduationPlan resource to be created or updated.", + "required": true, + "x-bodyName": "GraduationPlan" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89615,6 +111034,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -89731,7 +111211,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89774,7 +111254,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89794,27 +111274,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGunFreeSchoolsActReportingStatusesById", + "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGunFreeSchoolsActReportingStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -89828,48 +111321,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gunFreeSchoolsActReportingStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGunFreeSchoolsActReportingStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGunFreeSchoolsActReportingStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -89877,14 +111359,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -89896,20 +111378,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gunFreeSchoolsActReportingStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGunFreeSchoolsActReportingStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGunFreeSchoolsActReportingStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -89924,18 +111410,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor" - } - } - }, - "description": "The JSON representation of the GunFreeSchoolsActReportingStatus resource to be created or updated.", - "required": true, - "x-bodyName": "GunFreeSchoolsActReportingStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -89953,7 +111427,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gunFreeSchoolsActReportingStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGunFreeSchoolsActReportingStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gunFreeSchoolsActReportingStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGunFreeSchoolsActReportingStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor" + } + } + }, + "description": "The JSON representation of the GunFreeSchoolsActReportingStatus resource to be created or updated.", + "required": true, + "x-bodyName": "GunFreeSchoolsActReportingStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90178,6 +111767,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -90294,7 +111944,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90337,7 +111987,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90357,27 +112007,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteHomelessPrimaryNighttimeResidencesById", + "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessPrimaryNighttimeResidencesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -90391,48 +112054,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "homelessPrimaryNighttimeResidenceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getHomelessPrimaryNighttimeResidencesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessPrimaryNighttimeResidencesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -90440,14 +112092,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -90459,20 +112111,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "homelessPrimaryNighttimeResidenceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putHomelessPrimaryNighttimeResidence", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteHomelessPrimaryNighttimeResidencesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -90487,18 +112143,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor" - } - } - }, - "description": "The JSON representation of the HomelessPrimaryNighttimeResidence resource to be created or updated.", - "required": true, - "x-bodyName": "HomelessPrimaryNighttimeResidence" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -90516,7 +112160,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "homelessPrimaryNighttimeResidenceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getHomelessPrimaryNighttimeResidencesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "homelessPrimaryNighttimeResidenceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putHomelessPrimaryNighttimeResidence", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor" + } + } + }, + "description": "The JSON representation of the HomelessPrimaryNighttimeResidence resource to be created or updated.", + "required": true, + "x-bodyName": "HomelessPrimaryNighttimeResidence" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90741,6 +112500,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_HomelessProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_HomelessProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -90857,7 +112677,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90900,7 +112720,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90920,27 +112740,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/homelessProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteHomelessProgramServicesById", + "/ed-fi/homelessProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -90954,48 +112787,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "homelessProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/homelessProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getHomelessProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -91003,14 +112825,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -91022,20 +112844,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "homelessProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putHomelessProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/homelessProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteHomelessProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -91050,18 +112876,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the HomelessProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "HomelessProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -91079,7 +112893,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "homelessProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getHomelessProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "homelessProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putHomelessProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the HomelessProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "HomelessProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -91304,6 +113233,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IdeaPartDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IdeaPartDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IdeaPartDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -91420,7 +113410,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91463,7 +113453,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -91483,27 +113473,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/ideaPartDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIDEAPartsById", + "/ed-fi/ideaPartDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIDEAPartsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -91517,48 +113520,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "ideaPartDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ideaPartDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIDEAPartsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIDEAPartsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -91566,14 +113558,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -91585,20 +113577,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "ideaPartDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIDEAPart", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ideaPartDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIDEAPartsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -91613,18 +113609,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor" - } - } - }, - "description": "The JSON representation of the IDEAPart resource to be created or updated.", - "required": true, - "x-bodyName": "IDEAPart" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -91642,7 +113626,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "ideaPartDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIDEAPartsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "ideaPartDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIDEAPart", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor" + } + } + }, + "description": "The JSON representation of the IDEAPart resource to be created or updated.", + "required": true, + "x-bodyName": "IDEAPart" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -91867,6 +113966,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IdentificationDocumentUseDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -91983,7 +114143,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92026,7 +114186,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92046,27 +114206,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/identificationDocumentUseDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIdentificationDocumentUsesById", + "/ed-fi/identificationDocumentUseDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIdentificationDocumentUsesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -92080,48 +114253,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "identificationDocumentUseDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/identificationDocumentUseDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIdentificationDocumentUsesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIdentificationDocumentUsesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -92129,14 +114291,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -92148,20 +114310,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "identificationDocumentUseDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIdentificationDocumentUse", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/identificationDocumentUseDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIdentificationDocumentUsesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -92176,18 +114342,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor" - } - } - }, - "description": "The JSON representation of the IdentificationDocumentUse resource to be created or updated.", - "required": true, - "x-bodyName": "IdentificationDocumentUse" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -92205,7 +114359,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "identificationDocumentUseDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIdentificationDocumentUsesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "identificationDocumentUseDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIdentificationDocumentUse", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor" + } + } + }, + "description": "The JSON representation of the IdentificationDocumentUse resource to be created or updated.", + "required": true, + "x-bodyName": "IdentificationDocumentUse" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92430,6 +114699,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ImmunizationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ImmunizationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ImmunizationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -92546,7 +114876,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92589,7 +114919,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92609,27 +114939,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/immunizationTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteImmunizationTypesById", + "/ed-fi/immunizationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getImmunizationTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -92643,48 +114986,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "immunizationTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/immunizationTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getImmunizationTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getImmunizationTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -92692,14 +115024,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -92711,20 +115043,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "immunizationTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putImmunizationType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/immunizationTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteImmunizationTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -92739,18 +115075,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ImmunizationType resource to be created or updated.", - "required": true, - "x-bodyName": "ImmunizationType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -92768,7 +115092,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "immunizationTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getImmunizationTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "immunizationTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putImmunizationType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ImmunizationType resource to be created or updated.", + "required": true, + "x-bodyName": "ImmunizationType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92993,6 +115432,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IncidentLocationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IncidentLocationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IncidentLocationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -93109,7 +115609,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93152,7 +115652,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93172,27 +115672,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/incidentLocationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIncidentLocationsById", + "/ed-fi/incidentLocationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIncidentLocationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -93206,48 +115719,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "incidentLocationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/incidentLocationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIncidentLocationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIncidentLocationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -93255,14 +115757,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -93274,20 +115776,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "incidentLocationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIncidentLocation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/incidentLocationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIncidentLocationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -93302,18 +115808,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor" - } - } - }, - "description": "The JSON representation of the IncidentLocation resource to be created or updated.", - "required": true, - "x-bodyName": "IncidentLocation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -93331,7 +115825,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "incidentLocationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIncidentLocationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "incidentLocationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIncidentLocation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor" + } + } + }, + "description": "The JSON representation of the IncidentLocation resource to be created or updated.", + "required": true, + "x-bodyName": "IncidentLocation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93556,6 +116165,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IndicatorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IndicatorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IndicatorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -93672,7 +116342,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93715,7 +116385,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93735,27 +116405,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/indicatorDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIndicatorsById", + "/ed-fi/indicatorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -93769,48 +116452,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "indicatorDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIndicatorsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -93818,14 +116490,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -93837,20 +116509,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "indicatorDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIndicator", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIndicatorsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -93865,18 +116541,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorDescriptor" - } - } - }, - "description": "The JSON representation of the Indicator resource to be created or updated.", - "required": true, - "x-bodyName": "Indicator" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -93894,7 +116558,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "indicatorDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIndicatorsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "indicatorDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIndicator", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor" + } + } + }, + "description": "The JSON representation of the Indicator resource to be created or updated.", + "required": true, + "x-bodyName": "Indicator" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94119,6 +116898,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IndicatorGroupDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IndicatorGroupDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IndicatorGroupDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -94235,7 +117075,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94278,7 +117118,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94298,27 +117138,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/indicatorGroupDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIndicatorGroupsById", + "/ed-fi/indicatorGroupDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorGroupsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -94332,48 +117185,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "indicatorGroupDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorGroupDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIndicatorGroupsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorGroupsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -94381,14 +117223,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -94400,20 +117242,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "indicatorGroupDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIndicatorGroup", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorGroupDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIndicatorGroupsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -94428,18 +117274,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor" - } - } - }, - "description": "The JSON representation of the IndicatorGroup resource to be created or updated.", - "required": true, - "x-bodyName": "IndicatorGroup" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -94457,7 +117291,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "indicatorGroupDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIndicatorGroupsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "indicatorGroupDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIndicatorGroup", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor" + } + } + }, + "description": "The JSON representation of the IndicatorGroup resource to be created or updated.", + "required": true, + "x-bodyName": "IndicatorGroup" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94682,6 +117631,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IndicatorLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IndicatorLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IndicatorLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -94798,7 +117808,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94841,7 +117851,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94861,27 +117871,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/indicatorLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIndicatorLevelsById", + "/ed-fi/indicatorLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -94895,48 +117918,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "indicatorLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIndicatorLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -94944,14 +117956,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -94963,20 +117975,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "indicatorLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIndicatorLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIndicatorLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -94991,18 +118007,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor" - } - } - }, - "description": "The JSON representation of the IndicatorLevel resource to be created or updated.", - "required": true, - "x-bodyName": "IndicatorLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -95020,7 +118024,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "indicatorLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIndicatorLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "indicatorLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIndicatorLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor" + } + } + }, + "description": "The JSON representation of the IndicatorLevel resource to be created or updated.", + "required": true, + "x-bodyName": "IndicatorLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95245,6 +118364,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -95361,7 +118541,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95404,7 +118584,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95424,27 +118604,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/institutionTelephoneNumberTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInstitutionTelephoneNumberTypesById", + "/ed-fi/institutionTelephoneNumberTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInstitutionTelephoneNumberTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -95458,48 +118651,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "institutionTelephoneNumberTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/institutionTelephoneNumberTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInstitutionTelephoneNumberTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInstitutionTelephoneNumberTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -95507,14 +118689,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -95526,20 +118708,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "institutionTelephoneNumberTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInstitutionTelephoneNumberType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/institutionTelephoneNumberTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInstitutionTelephoneNumberTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -95554,18 +118740,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor" - } - } - }, - "description": "The JSON representation of the InstitutionTelephoneNumberType resource to be created or updated.", - "required": true, - "x-bodyName": "InstitutionTelephoneNumberType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -95583,7 +118757,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "institutionTelephoneNumberTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInstitutionTelephoneNumberTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "institutionTelephoneNumberTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInstitutionTelephoneNumberType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor" + } + } + }, + "description": "The JSON representation of the InstitutionTelephoneNumberType resource to be created or updated.", + "required": true, + "x-bodyName": "InstitutionTelephoneNumberType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95808,6 +119097,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InteractivityStyleDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InteractivityStyleDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InteractivityStyleDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -95924,7 +119274,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95967,7 +119317,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95987,27 +119337,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/interactivityStyleDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInteractivityStylesById", + "/ed-fi/interactivityStyleDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInteractivityStylesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -96021,48 +119384,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interactivityStyleDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interactivityStyleDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInteractivityStylesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInteractivityStylesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -96070,14 +119422,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -96089,20 +119441,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interactivityStyleDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInteractivityStyle", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interactivityStyleDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInteractivityStylesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -96117,18 +119473,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor" - } - } - }, - "description": "The JSON representation of the InteractivityStyle resource to be created or updated.", - "required": true, - "x-bodyName": "InteractivityStyle" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -96146,7 +119490,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interactivityStyleDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInteractivityStylesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interactivityStyleDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInteractivityStyle", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor" + } + } + }, + "description": "The JSON representation of the InteractivityStyle resource to be created or updated.", + "required": true, + "x-bodyName": "InteractivityStyle" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96371,6 +119830,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InternetAccessDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InternetAccessDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InternetAccessDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -96487,7 +120007,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -96530,7 +120050,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96550,27 +120070,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/internetAccessDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInternetAccessesById", + "/ed-fi/internetAccessDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -96584,48 +120117,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "internetAccessDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetAccessDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInternetAccessesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -96633,14 +120155,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -96652,20 +120174,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "internetAccessDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInternetAccess", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetAccessDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInternetAccessesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -96680,18 +120206,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor" - } - } - }, - "description": "The JSON representation of the InternetAccess resource to be created or updated.", - "required": true, - "x-bodyName": "InternetAccess" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -96709,7 +120223,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "internetAccessDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInternetAccessesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "internetAccessDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInternetAccess", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor" + } + } + }, + "description": "The JSON representation of the InternetAccess resource to be created or updated.", + "required": true, + "x-bodyName": "InternetAccess" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96934,6 +120563,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -97050,7 +120740,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97093,7 +120783,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -97113,27 +120803,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/internetAccessTypeInResidenceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInternetAccessTypeInResidencesById", + "/ed-fi/internetAccessTypeInResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessTypeInResidencesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -97147,48 +120850,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "internetAccessTypeInResidenceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetAccessTypeInResidenceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInternetAccessTypeInResidencesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessTypeInResidencesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -97196,14 +120888,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -97215,20 +120907,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "internetAccessTypeInResidenceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInternetAccessTypeInResidence", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetAccessTypeInResidenceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInternetAccessTypeInResidencesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -97243,18 +120939,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor" - } - } - }, - "description": "The JSON representation of the InternetAccessTypeInResidence resource to be created or updated.", - "required": true, - "x-bodyName": "InternetAccessTypeInResidence" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -97272,7 +120956,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "internetAccessTypeInResidenceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInternetAccessTypeInResidencesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "internetAccessTypeInResidenceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInternetAccessTypeInResidence", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor" + } + } + }, + "description": "The JSON representation of the InternetAccessTypeInResidence resource to be created or updated.", + "required": true, + "x-bodyName": "InternetAccessTypeInResidence" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -97497,6 +121296,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -97613,7 +121473,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97656,7 +121516,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -97676,27 +121536,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/internetPerformanceInResidenceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInternetPerformanceInResidencesById", + "/ed-fi/internetPerformanceInResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInternetPerformanceInResidencesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -97710,48 +121583,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "internetPerformanceInResidenceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetPerformanceInResidenceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInternetPerformanceInResidencesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInternetPerformanceInResidencesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -97759,14 +121621,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -97778,20 +121640,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "internetPerformanceInResidenceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInternetPerformanceInResidence", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetPerformanceInResidenceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInternetPerformanceInResidencesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -97806,18 +121672,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor" - } - } - }, - "description": "The JSON representation of the InternetPerformanceInResidence resource to be created or updated.", - "required": true, - "x-bodyName": "InternetPerformanceInResidence" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -97835,7 +121689,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "internetPerformanceInResidenceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInternetPerformanceInResidencesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "internetPerformanceInResidenceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInternetPerformanceInResidence", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor" + } + } + }, + "description": "The JSON representation of the InternetPerformanceInResidence resource to be created or updated.", + "required": true, + "x-bodyName": "InternetPerformanceInResidence" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98060,6 +122029,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InterventionClassDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionClassDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InterventionClassDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -98176,7 +122206,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98219,7 +122249,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98239,27 +122269,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/interventionClassDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInterventionClassesById", + "/ed-fi/interventionClassDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionClassesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -98273,48 +122316,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interventionClassDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interventionClassDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInterventionClassesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionClassesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -98322,14 +122354,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -98341,20 +122373,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interventionClassDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInterventionClass", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interventionClassDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInterventionClassesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -98369,18 +122405,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor" - } - } - }, - "description": "The JSON representation of the InterventionClass resource to be created or updated.", - "required": true, - "x-bodyName": "InterventionClass" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -98398,7 +122422,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interventionClassDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInterventionClassesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interventionClassDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInterventionClass", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor" + } + } + }, + "description": "The JSON representation of the InterventionClass resource to be created or updated.", + "required": true, + "x-bodyName": "InterventionClass" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98623,6 +122762,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -98739,7 +122939,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98782,7 +122982,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98802,27 +123002,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/interventionEffectivenessRatingDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInterventionEffectivenessRatingsById", + "/ed-fi/interventionEffectivenessRatingDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionEffectivenessRatingsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -98836,48 +123049,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interventionEffectivenessRatingDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interventionEffectivenessRatingDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInterventionEffectivenessRatingsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionEffectivenessRatingsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -98885,14 +123087,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -98904,20 +123106,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interventionEffectivenessRatingDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInterventionEffectivenessRating", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interventionEffectivenessRatingDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInterventionEffectivenessRatingsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -98932,18 +123138,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor" - } - } - }, - "description": "The JSON representation of the InterventionEffectivenessRating resource to be created or updated.", - "required": true, - "x-bodyName": "InterventionEffectivenessRating" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -98961,7 +123155,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interventionEffectivenessRatingDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInterventionEffectivenessRatingsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interventionEffectivenessRatingDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInterventionEffectivenessRating", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor" + } + } + }, + "description": "The JSON representation of the InterventionEffectivenessRating resource to be created or updated.", + "required": true, + "x-bodyName": "InterventionEffectivenessRating" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -99673,6 +123982,67 @@ "interventionPrescriptionIdentificationCode" ], "type": "object" + }, + "EdFi_InterventionPrescription_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionPrescription_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionPrescriptionIdentificationCode": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ], + "type": "object" + }, + "EdFi_InterventionPrescription_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -99799,7 +124169,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99842,7 +124212,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -99863,27 +124233,40 @@ "Intervention" ] }, - "/ed-fi/interventionPrescriptions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInterventionPrescriptionsById", + "/ed-fi/interventionPrescriptions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionPrescriptionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -99897,48 +124280,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interventionPrescriptions" ] }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/interventionPrescriptions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInterventionPrescriptionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionPrescriptionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -99946,14 +124319,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InterventionPrescription" + "items": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -99965,20 +124338,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interventionPrescriptions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInterventionPrescription", + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/interventionPrescriptions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInterventionPrescriptionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -99993,18 +124371,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InterventionPrescription" - } - } - }, - "description": "The JSON representation of the InterventionPrescription resource to be created or updated.", - "required": true, - "x-bodyName": "InterventionPrescription" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -100022,7 +124388,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interventionPrescriptions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInterventionPrescriptionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interventionPrescriptions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInterventionPrescription", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription" + } + } + }, + "description": "The JSON representation of the InterventionPrescription resource to be created or updated.", + "required": true, + "x-bodyName": "InterventionPrescription" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100892,6 +125373,67 @@ "stateAbbreviationDescriptor" ], "type": "object" + }, + "EdFi_InterventionStudy_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionStudy_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionStudyIdentificationCode": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionStudyIdentificationCode" + ], + "type": "object" + }, + "EdFi_InterventionStudy_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -101019,7 +125561,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -101062,7 +125604,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -101083,27 +125625,40 @@ "Intervention" ] }, - "/ed-fi/interventionStudies/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInterventionStudiesById", + "/ed-fi/interventionStudies/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionStudiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -101117,48 +125672,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interventionStudies" ] }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/interventionStudies/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInterventionStudiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionStudiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -101166,14 +125711,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InterventionStudy" + "items": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -101185,20 +125730,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interventionStudies" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInterventionStudy", + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/interventionStudies/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInterventionStudiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -101213,18 +125763,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InterventionStudy" - } - } - }, - "description": "The JSON representation of the InterventionStudy resource to be created or updated.", - "required": true, - "x-bodyName": "InterventionStudy" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -101242,7 +125780,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interventionStudies" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInterventionStudiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionStudy" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interventionStudies" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInterventionStudy", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionStudy" + } + } + }, + "description": "The JSON representation of the InterventionStudy resource to be created or updated.", + "required": true, + "x-bodyName": "InterventionStudy" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -102219,6 +126872,67 @@ "staffReference" ], "type": "object" + }, + "EdFi_Intervention_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Intervention_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionIdentificationCode": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionIdentificationCode" + ], + "type": "object" + }, + "EdFi_Intervention_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -102363,7 +127077,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102406,7 +127120,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -102428,27 +127142,40 @@ "StudentCohort" ] }, - "/ed-fi/interventions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInterventionsById", + "/ed-fi/interventions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -102462,48 +127189,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interventions" ] }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/interventions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInterventionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -102511,14 +127229,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Intervention" + "items": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -102530,20 +127248,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interventions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIntervention", + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/interventions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInterventionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -102558,18 +127282,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Intervention" - } - } - }, - "description": "The JSON representation of the Intervention resource to be created or updated.", - "required": true, - "x-bodyName": "Intervention" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -102587,7 +127299,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interventions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInterventionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Intervention" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interventions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIntervention", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Intervention" + } + } + }, + "description": "The JSON representation of the Intervention resource to be created or updated.", + "required": true, + "x-bodyName": "Intervention" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -102840,6 +127667,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LanguageDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LanguageDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LanguageDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -102956,7 +127844,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102999,7 +127887,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -103019,27 +127907,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/languageDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLanguagesById", + "/ed-fi/languageDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLanguagesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -103053,48 +127954,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "languageDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLanguagesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLanguagesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -103102,14 +127992,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LanguageDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -103121,20 +128011,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "languageDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLanguage", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLanguagesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -103149,18 +128043,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LanguageDescriptor" - } - } - }, - "description": "The JSON representation of the Language resource to be created or updated.", - "required": true, - "x-bodyName": "Language" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -103178,7 +128060,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "languageDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLanguagesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "languageDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLanguage", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor" + } + } + }, + "description": "The JSON representation of the Language resource to be created or updated.", + "required": true, + "x-bodyName": "Language" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -103403,6 +128400,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -103519,7 +128577,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -103562,7 +128620,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -103582,27 +128640,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/languageInstructionProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLanguageInstructionProgramServicesById", + "/ed-fi/languageInstructionProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageInstructionProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -103616,48 +128687,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "languageInstructionProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageInstructionProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLanguageInstructionProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageInstructionProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -103665,14 +128725,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -103684,20 +128744,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "languageInstructionProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLanguageInstructionProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageInstructionProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLanguageInstructionProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -103712,18 +128776,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the LanguageInstructionProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "LanguageInstructionProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -103741,7 +128793,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "languageInstructionProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLanguageInstructionProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "languageInstructionProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLanguageInstructionProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the LanguageInstructionProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "LanguageInstructionProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -103966,6 +129133,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LanguageUseDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LanguageUseDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LanguageUseDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -104082,7 +129310,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104125,7 +129353,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -104145,27 +129373,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/languageUseDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLanguageUsesById", + "/ed-fi/languageUseDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageUsesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -104179,48 +129420,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "languageUseDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageUseDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLanguageUsesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageUsesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -104228,14 +129458,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -104247,20 +129477,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "languageUseDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLanguageUse", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageUseDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLanguageUsesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -104275,18 +129509,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor" - } - } - }, - "description": "The JSON representation of the LanguageUse resource to be created or updated.", - "required": true, - "x-bodyName": "LanguageUse" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -104304,7 +129526,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "languageUseDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLanguageUsesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "languageUseDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLanguageUse", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor" + } + } + }, + "description": "The JSON representation of the LanguageUse resource to be created or updated.", + "required": true, + "x-bodyName": "LanguageUse" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -104529,6 +129866,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LearningStandardCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LearningStandardCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -104645,7 +130043,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104688,7 +130086,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -104708,27 +130106,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/learningStandardCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLearningStandardCategoriesById", + "/ed-fi/learningStandardCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -104742,48 +130153,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "learningStandardCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLearningStandardCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -104791,14 +130191,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -104810,20 +130210,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "learningStandardCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLearningStandardCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLearningStandardCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -104838,18 +130242,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the LearningStandardCategory resource to be created or updated.", - "required": true, - "x-bodyName": "LearningStandardCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -104867,7 +130259,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "learningStandardCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLearningStandardCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "learningStandardCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLearningStandardCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the LearningStandardCategory resource to be created or updated.", + "required": true, + "x-bodyName": "LearningStandardCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -105194,6 +130701,73 @@ "targetLearningStandardId" ], "type": "object" + }, + "EdFi_LearningStandardEquivalenceAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "sourceLearningStandardId": { + "maxLength": 60, + "type": "string" + }, + "targetLearningStandardId": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "namespace", + "sourceLearningStandardId", + "targetLearningStandardId" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -105312,7 +130886,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -105355,7 +130929,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -105375,27 +130949,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/learningStandardEquivalenceAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLearningStandardEquivalenceAssociationsById", + "/ed-fi/learningStandardEquivalenceAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -105409,48 +130996,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "learningStandardEquivalenceAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardEquivalenceAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLearningStandardEquivalenceAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -105458,14 +131034,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -105477,20 +131053,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "learningStandardEquivalenceAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLearningStandardEquivalenceAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardEquivalenceAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLearningStandardEquivalenceAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -105505,18 +131085,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation" - } - } - }, - "description": "The JSON representation of the LearningStandardEquivalenceAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "LearningStandardEquivalenceAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -105534,7 +131102,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "learningStandardEquivalenceAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLearningStandardEquivalenceAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "learningStandardEquivalenceAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLearningStandardEquivalenceAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation" + } + } + }, + "description": "The JSON representation of the LearningStandardEquivalenceAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "LearningStandardEquivalenceAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -105765,6 +131448,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -105881,7 +131625,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -105924,7 +131668,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -105944,27 +131688,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/learningStandardEquivalenceStrengthDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLearningStandardEquivalenceStrengthsById", + "/ed-fi/learningStandardEquivalenceStrengthDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceStrengthsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -105978,48 +131735,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "learningStandardEquivalenceStrengthDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardEquivalenceStrengthDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLearningStandardEquivalenceStrengthsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceStrengthsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -106027,14 +131773,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -106046,20 +131792,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "learningStandardEquivalenceStrengthDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLearningStandardEquivalenceStrength", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardEquivalenceStrengthDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLearningStandardEquivalenceStrengthsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -106074,18 +131824,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor" - } - } - }, - "description": "The JSON representation of the LearningStandardEquivalenceStrength resource to be created or updated.", - "required": true, - "x-bodyName": "LearningStandardEquivalenceStrength" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -106103,7 +131841,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "learningStandardEquivalenceStrengthDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLearningStandardEquivalenceStrengthsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "learningStandardEquivalenceStrengthDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLearningStandardEquivalenceStrength", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor" + } + } + }, + "description": "The JSON representation of the LearningStandardEquivalenceStrength resource to be created or updated.", + "required": true, + "x-bodyName": "LearningStandardEquivalenceStrength" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106328,6 +132181,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LearningStandardScopeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardScopeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LearningStandardScopeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -106444,7 +132358,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106487,7 +132401,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106507,27 +132421,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/learningStandardScopeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLearningStandardScopesById", + "/ed-fi/learningStandardScopeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardScopesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -106541,48 +132468,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "learningStandardScopeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardScopeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLearningStandardScopesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardScopesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -106590,14 +132506,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -106609,20 +132525,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "learningStandardScopeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLearningStandardScope", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardScopeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLearningStandardScopesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -106637,18 +132557,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor" - } - } - }, - "description": "The JSON representation of the LearningStandardScope resource to be created or updated.", - "required": true, - "x-bodyName": "LearningStandardScope" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -106666,7 +132574,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "learningStandardScopeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLearningStandardScopesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "learningStandardScopeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLearningStandardScope", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor" + } + } + }, + "description": "The JSON representation of the LearningStandardScope resource to be created or updated.", + "required": true, + "x-bodyName": "LearningStandardScope" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107487,6 +133510,62 @@ "learningStandardId" ], "type": "object" + }, + "EdFi_LearningStandard_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandard_TrackedChangeKey": { + "properties": { + "learningStandardId": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "learningStandardId" + ], + "type": "object" + }, + "EdFi_LearningStandard_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -107641,7 +133720,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107684,7 +133763,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107710,27 +133789,40 @@ "Standards" ] }, - "/ed-fi/learningStandards/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLearningStandardsById", + "/ed-fi/learningStandards/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -107744,48 +133836,43 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "learningStandards" ] }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "Standards" + ] + }, + "/ed-fi/learningStandards/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLearningStandardsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -107793,14 +133880,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandard" + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -107812,20 +133899,30 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "learningStandards" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLearningStandard", + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "Standards" + ] + }, + "/ed-fi/learningStandards/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLearningStandardsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -107840,18 +133937,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandard" - } - } - }, - "description": "The JSON representation of the LearningStandard resource to be created or updated.", - "required": true, - "x-bodyName": "LearningStandard" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -107869,7 +133954,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "learningStandards" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLearningStandardsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandard" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "learningStandards" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLearningStandard", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandard" + } + } + }, + "description": "The JSON representation of the LearningStandard resource to be created or updated.", + "required": true, + "x-bodyName": "LearningStandard" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108131,6 +134331,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LevelOfEducationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LevelOfEducationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LevelOfEducationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -108247,7 +134508,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108290,7 +134551,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108310,27 +134571,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/levelOfEducationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLevelOfEducationsById", + "/ed-fi/levelOfEducationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLevelOfEducationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -108344,48 +134618,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "levelOfEducationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/levelOfEducationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLevelOfEducationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLevelOfEducationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -108393,14 +134656,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -108412,20 +134675,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "levelOfEducationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLevelOfEducation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/levelOfEducationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLevelOfEducationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -108440,18 +134707,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor" - } - } - }, - "description": "The JSON representation of the LevelOfEducation resource to be created or updated.", - "required": true, - "x-bodyName": "LevelOfEducation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -108469,7 +134724,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "levelOfEducationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLevelOfEducationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "levelOfEducationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLevelOfEducation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor" + } + } + }, + "description": "The JSON representation of the LevelOfEducation resource to be created or updated.", + "required": true, + "x-bodyName": "LevelOfEducation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108694,6 +135064,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LicenseStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LicenseStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LicenseStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -108810,7 +135241,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108853,7 +135284,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108873,27 +135304,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/licenseStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLicenseStatusesById", + "/ed-fi/licenseStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -108907,48 +135351,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "licenseStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/licenseStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLicenseStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -108956,14 +135389,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -108975,20 +135408,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "licenseStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLicenseStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/licenseStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLicenseStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -109003,18 +135440,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor" - } - } - }, - "description": "The JSON representation of the LicenseStatus resource to be created or updated.", - "required": true, - "x-bodyName": "LicenseStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -109032,7 +135457,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "licenseStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLicenseStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "licenseStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLicenseStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor" + } + } + }, + "description": "The JSON representation of the LicenseStatus resource to be created or updated.", + "required": true, + "x-bodyName": "LicenseStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109257,6 +135797,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LicenseTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LicenseTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LicenseTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -109373,7 +135974,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109416,7 +136017,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109436,27 +136037,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/licenseTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLicenseTypesById", + "/ed-fi/licenseTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -109470,48 +136084,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "licenseTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/licenseTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLicenseTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -109519,14 +136122,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -109538,20 +136141,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "licenseTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLicenseType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/licenseTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLicenseTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -109566,18 +136173,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor" - } - } - }, - "description": "The JSON representation of the LicenseType resource to be created or updated.", - "required": true, - "x-bodyName": "LicenseType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -109595,7 +136190,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "licenseTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLicenseTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "licenseTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLicenseType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor" + } + } + }, + "description": "The JSON representation of the LicenseType resource to be created or updated.", + "required": true, + "x-bodyName": "LicenseType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109820,6 +136530,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -109936,7 +136707,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109979,7 +136750,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109999,27 +136770,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/limitedEnglishProficiencyDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLimitedEnglishProficienciesById", + "/ed-fi/limitedEnglishProficiencyDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLimitedEnglishProficienciesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -110033,48 +136817,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "limitedEnglishProficiencyDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/limitedEnglishProficiencyDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLimitedEnglishProficienciesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLimitedEnglishProficienciesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -110082,14 +136855,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -110101,20 +136874,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "limitedEnglishProficiencyDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLimitedEnglishProficiency", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/limitedEnglishProficiencyDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLimitedEnglishProficienciesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -110129,18 +136906,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor" - } - } - }, - "description": "The JSON representation of the LimitedEnglishProficiency resource to be created or updated.", - "required": true, - "x-bodyName": "LimitedEnglishProficiency" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -110158,7 +136923,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "limitedEnglishProficiencyDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLimitedEnglishProficienciesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "limitedEnglishProficiencyDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLimitedEnglishProficiency", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor" + } + } + }, + "description": "The JSON representation of the LimitedEnglishProficiency resource to be created or updated.", + "required": true, + "x-bodyName": "LimitedEnglishProficiency" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -110572,6 +137452,72 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_LocalAccount_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalAccount_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalAccount_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -110691,7 +137637,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110734,7 +137680,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -110755,27 +137701,40 @@ "Finance" ] }, - "/ed-fi/localAccounts/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalAccountsById", + "/ed-fi/localAccounts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalAccountsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -110789,48 +137748,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localAccounts" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localAccounts/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalAccountsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalAccountsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -110838,14 +137787,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalAccount" + "items": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -110857,20 +137806,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localAccounts" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalAccount", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localAccounts/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalAccountsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -110885,18 +137839,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalAccount" - } - } - }, - "description": "The JSON representation of the LocalAccount resource to be created or updated.", - "required": true, - "x-bodyName": "LocalAccount" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -110914,7 +137856,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localAccounts" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalAccountsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalAccount" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localAccounts" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalAccount", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalAccount" + } + } + }, + "description": "The JSON representation of the LocalAccount resource to be created or updated.", + "required": true, + "x-bodyName": "LocalAccount" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111235,6 +138292,77 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_LocalActual_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalActual_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalActual_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -111353,7 +138481,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111396,7 +138524,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111417,27 +138545,40 @@ "Finance" ] }, - "/ed-fi/localActuals/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalActualsById", + "/ed-fi/localActuals/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalActualsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -111451,48 +138592,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localActuals" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localActuals/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalActualsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalActualsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -111500,14 +138631,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalActual" + "items": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -111519,20 +138650,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localActuals" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalActual", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localActuals/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalActualsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -111547,18 +138683,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalActual" - } - } - }, - "description": "The JSON representation of the LocalActual resource to be created or updated.", - "required": true, - "x-bodyName": "LocalActual" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -111576,7 +138700,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localActuals" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalActualsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalActual" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localActuals" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalActual", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalActual" + } + } + }, + "description": "The JSON representation of the LocalActual resource to be created or updated.", + "required": true, + "x-bodyName": "LocalActual" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111892,6 +139131,77 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_LocalBudget_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalBudget_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalBudget_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -112010,7 +139320,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112053,7 +139363,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112074,27 +139384,40 @@ "Finance" ] }, - "/ed-fi/localBudgets/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalBudgetsById", + "/ed-fi/localBudgets/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalBudgetsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -112108,48 +139431,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localBudgets" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localBudgets/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalBudgetsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalBudgetsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -112157,14 +139470,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalBudget" + "items": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -112176,20 +139489,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localBudgets" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalBudget", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localBudgets/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalBudgetsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -112204,18 +139522,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalBudget" - } - } - }, - "description": "The JSON representation of the LocalBudget resource to be created or updated.", - "required": true, - "x-bodyName": "LocalBudget" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -112233,7 +139539,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localBudgets" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalBudgetsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalBudget" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localBudgets" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalBudget", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalBudget" + } + } + }, + "description": "The JSON representation of the LocalBudget resource to be created or updated.", + "required": true, + "x-bodyName": "LocalBudget" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112593,6 +140014,82 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_LocalContractedStaff_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalContractedStaff_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_LocalContractedStaff_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -112721,7 +140218,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112764,7 +140261,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112785,27 +140282,40 @@ "Finance" ] }, - "/ed-fi/localContractedStaffs/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalContractedStaffsById", + "/ed-fi/localContractedStaffs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalContractedStaffsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -112819,48 +140329,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localContractedStaffs" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localContractedStaffs/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalContractedStaffsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalContractedStaffsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -112868,14 +140368,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalContractedStaff" + "items": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -112887,20 +140387,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localContractedStaffs" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalContractedStaff", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localContractedStaffs/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalContractedStaffsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -112915,18 +140420,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalContractedStaff" - } - } - }, - "description": "The JSON representation of the LocalContractedStaff resource to be created or updated.", - "required": true, - "x-bodyName": "LocalContractedStaff" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -112944,7 +140437,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localContractedStaffs" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalContractedStaffsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localContractedStaffs" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalContractedStaff", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff" + } + } + }, + "description": "The JSON representation of the LocalContractedStaff resource to be created or updated.", + "required": true, + "x-bodyName": "LocalContractedStaff" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -114713,6 +142321,62 @@ "localEducationAgencyId" ], "type": "object" + }, + "EdFi_LocalEducationAgency_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalEducationAgency_TrackedChangeKey": { + "properties": { + "localEducationAgencyId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "localEducationAgencyId" + ], + "type": "object" + }, + "EdFi_LocalEducationAgency_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -114868,7 +142532,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114911,7 +142575,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -114934,27 +142598,40 @@ "Staff" ] }, - "/ed-fi/localEducationAgencies/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalEducationAgenciesById", + "/ed-fi/localEducationAgencies/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgenciesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -114968,48 +142645,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localEducationAgencies" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, + "/ed-fi/localEducationAgencies/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalEducationAgenciesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgenciesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -115017,14 +142686,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalEducationAgency" + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -115036,20 +142705,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localEducationAgencies" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalEducationAgency", + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, + "/ed-fi/localEducationAgencies/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalEducationAgenciesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -115064,18 +142740,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalEducationAgency" - } - } - }, - "description": "The JSON representation of the LocalEducationAgency resource to be created or updated.", - "required": true, - "x-bodyName": "LocalEducationAgency" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -115093,7 +142757,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localEducationAgencies" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalEducationAgenciesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localEducationAgencies" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalEducationAgency", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency" + } + } + }, + "description": "The JSON representation of the LocalEducationAgency resource to be created or updated.", + "required": true, + "x-bodyName": "LocalEducationAgency" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -115362,6 +143141,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -115478,7 +143318,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -115521,7 +143361,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -115541,27 +143381,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/localEducationAgencyCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalEducationAgencyCategoriesById", + "/ed-fi/localEducationAgencyCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgencyCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -115575,48 +143428,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localEducationAgencyCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/localEducationAgencyCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalEducationAgencyCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgencyCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -115624,14 +143466,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -115643,20 +143485,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localEducationAgencyCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalEducationAgencyCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/localEducationAgencyCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalEducationAgencyCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -115671,18 +143517,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the LocalEducationAgencyCategory resource to be created or updated.", - "required": true, - "x-bodyName": "LocalEducationAgencyCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -115700,7 +143534,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localEducationAgencyCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalEducationAgencyCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localEducationAgencyCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalEducationAgencyCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the LocalEducationAgencyCategory resource to be created or updated.", + "required": true, + "x-bodyName": "LocalEducationAgencyCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -116012,6 +143961,77 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_LocalEncumbrance_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalEncumbrance_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalEncumbrance_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -116130,7 +144150,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -116173,7 +144193,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -116194,27 +144214,40 @@ "Finance" ] }, - "/ed-fi/localEncumbrances/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalEncumbrancesById", + "/ed-fi/localEncumbrances/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEncumbrancesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -116228,48 +144261,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localEncumbrances" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localEncumbrances/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalEncumbrancesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEncumbrancesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -116277,14 +144300,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalEncumbrance" + "items": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -116296,20 +144319,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localEncumbrances" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalEncumbrance", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localEncumbrances/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalEncumbrancesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -116324,18 +144352,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalEncumbrance" - } - } - }, - "description": "The JSON representation of the LocalEncumbrance resource to be created or updated.", - "required": true, - "x-bodyName": "LocalEncumbrance" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -116353,7 +144369,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localEncumbrances" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalEncumbrancesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localEncumbrances" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalEncumbrance", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance" + } + } + }, + "description": "The JSON representation of the LocalEncumbrance resource to be created or updated.", + "required": true, + "x-bodyName": "LocalEncumbrance" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -116713,6 +144844,82 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_LocalPayroll_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalPayroll_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_LocalPayroll_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -116841,7 +145048,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -116884,7 +145091,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -116905,27 +145112,40 @@ "Finance" ] }, - "/ed-fi/localPayrolls/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalPayrollsById", + "/ed-fi/localPayrolls/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalPayrollsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -116939,48 +145159,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localPayrolls" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localPayrolls/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalPayrollsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalPayrollsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -116988,14 +145198,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalPayroll" + "items": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -117007,20 +145217,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localPayrolls" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalPayroll", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localPayrolls/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalPayrollsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -117035,18 +145250,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalPayroll" - } - } - }, - "description": "The JSON representation of the LocalPayroll resource to be created or updated.", - "required": true, - "x-bodyName": "LocalPayroll" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -117064,7 +145267,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localPayrolls" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalPayrollsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalPayroll" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localPayrolls" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalPayroll", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalPayroll" + } + } + }, + "description": "The JSON representation of the LocalPayroll resource to be created or updated.", + "required": true, + "x-bodyName": "LocalPayroll" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -117300,6 +145618,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LocaleDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocaleDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LocaleDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -117416,7 +145795,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -117459,7 +145838,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -117479,27 +145858,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/localeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalesById", + "/ed-fi/localeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -117513,48 +145905,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/localeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -117562,14 +145943,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocaleDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -117581,20 +145962,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocale", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/localeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -117609,18 +145994,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocaleDescriptor" - } - } - }, - "description": "The JSON representation of the Locale resource to be created or updated.", - "required": true, - "x-bodyName": "Locale" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -117638,7 +146011,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocale", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor" + } + } + }, + "description": "The JSON representation of the Locale resource to be created or updated.", + "required": true, + "x-bodyName": "Locale" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -117900,6 +146388,67 @@ "schoolId" ], "type": "object" + }, + "EdFi_Location_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Location_TrackedChangeKey": { + "properties": { + "classroomIdentificationCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "classroomIdentificationCode", + "schoolId" + ], + "type": "object" + }, + "EdFi_Location_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -117998,7 +146547,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118041,7 +146590,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118063,27 +146612,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/locations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocationsById", + "/ed-fi/locations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -118097,48 +146659,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "locations" ] }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/locations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -118146,14 +146699,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Location" + "items": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -118165,20 +146718,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "locations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocation", + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/locations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -118193,18 +146752,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Location" - } - } - }, - "description": "The JSON representation of the Location resource to be created or updated.", - "required": true, - "x-bodyName": "Location" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -118222,7 +146769,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "locations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Location" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "locations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Location" + } + } + }, + "description": "The JSON representation of the Location resource to be created or updated.", + "required": true, + "x-bodyName": "Location" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118441,6 +147103,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -118557,7 +147280,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118600,7 +147323,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118620,27 +147343,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteMagnetSpecialProgramEmphasisSchoolsById", + "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMagnetSpecialProgramEmphasisSchoolsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -118654,48 +147390,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "magnetSpecialProgramEmphasisSchoolDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getMagnetSpecialProgramEmphasisSchoolsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMagnetSpecialProgramEmphasisSchoolsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -118703,14 +147428,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -118722,20 +147447,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "magnetSpecialProgramEmphasisSchoolDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putMagnetSpecialProgramEmphasisSchool", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteMagnetSpecialProgramEmphasisSchoolsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -118750,18 +147479,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor" - } - } - }, - "description": "The JSON representation of the MagnetSpecialProgramEmphasisSchool resource to be created or updated.", - "required": true, - "x-bodyName": "MagnetSpecialProgramEmphasisSchool" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -118779,7 +147496,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "magnetSpecialProgramEmphasisSchoolDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getMagnetSpecialProgramEmphasisSchoolsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "magnetSpecialProgramEmphasisSchoolDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putMagnetSpecialProgramEmphasisSchool", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor" + } + } + }, + "description": "The JSON representation of the MagnetSpecialProgramEmphasisSchool resource to be created or updated.", + "required": true, + "x-bodyName": "MagnetSpecialProgramEmphasisSchool" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119004,6 +147836,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MediumOfInstructionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MediumOfInstructionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MediumOfInstructionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -119120,7 +148013,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119163,7 +148056,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119183,27 +148076,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/mediumOfInstructionDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteMediumOfInstructionsById", + "/ed-fi/mediumOfInstructionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMediumOfInstructionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -119217,48 +148123,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "mediumOfInstructionDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/mediumOfInstructionDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getMediumOfInstructionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMediumOfInstructionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -119266,14 +148161,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -119285,20 +148180,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "mediumOfInstructionDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putMediumOfInstruction", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/mediumOfInstructionDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteMediumOfInstructionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -119313,18 +148212,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor" - } - } - }, - "description": "The JSON representation of the MediumOfInstruction resource to be created or updated.", - "required": true, - "x-bodyName": "MediumOfInstruction" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -119342,7 +148229,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "mediumOfInstructionDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getMediumOfInstructionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "mediumOfInstructionDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putMediumOfInstruction", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor" + } + } + }, + "description": "The JSON representation of the MediumOfInstruction resource to be created or updated.", + "required": true, + "x-bodyName": "MediumOfInstruction" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119567,6 +148569,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MethodCreditEarnedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MethodCreditEarnedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -119683,7 +148746,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119726,7 +148789,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119746,27 +148809,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/methodCreditEarnedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteMethodCreditEarnedsById", + "/ed-fi/methodCreditEarnedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMethodCreditEarnedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -119780,48 +148856,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "methodCreditEarnedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/methodCreditEarnedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getMethodCreditEarnedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMethodCreditEarnedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -119829,14 +148894,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -119848,20 +148913,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "methodCreditEarnedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putMethodCreditEarned", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/methodCreditEarnedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteMethodCreditEarnedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -119876,18 +148945,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor" - } - } - }, - "description": "The JSON representation of the MethodCreditEarned resource to be created or updated.", - "required": true, - "x-bodyName": "MethodCreditEarned" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -119905,7 +148962,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "methodCreditEarnedDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getMethodCreditEarnedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "methodCreditEarnedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putMethodCreditEarned", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor" + } + } + }, + "description": "The JSON representation of the MethodCreditEarned resource to be created or updated.", + "required": true, + "x-bodyName": "MethodCreditEarned" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120130,6 +149302,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -120246,7 +149479,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120289,7 +149522,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120309,27 +149542,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/migrantEducationProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteMigrantEducationProgramServicesById", + "/ed-fi/migrantEducationProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMigrantEducationProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -120343,48 +149589,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "migrantEducationProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/migrantEducationProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getMigrantEducationProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMigrantEducationProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -120392,14 +149627,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -120411,20 +149646,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "migrantEducationProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putMigrantEducationProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/migrantEducationProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteMigrantEducationProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -120439,18 +149678,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the MigrantEducationProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "MigrantEducationProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -120468,7 +149695,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "migrantEducationProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getMigrantEducationProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "migrantEducationProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putMigrantEducationProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the MigrantEducationProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "MigrantEducationProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120693,6 +150035,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ModelEntityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ModelEntityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ModelEntityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -120809,7 +150212,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120852,7 +150255,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120872,27 +150275,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/modelEntityDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteModelEntitiesById", + "/ed-fi/modelEntityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getModelEntitiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -120906,48 +150322,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "modelEntityDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/modelEntityDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getModelEntitiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getModelEntitiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -120955,14 +150360,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -120974,20 +150379,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "modelEntityDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putModelEntity", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/modelEntityDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteModelEntitiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -121002,18 +150411,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor" - } - } - }, - "description": "The JSON representation of the ModelEntity resource to be created or updated.", - "required": true, - "x-bodyName": "ModelEntity" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -121031,7 +150428,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "modelEntityDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getModelEntitiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "modelEntityDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putModelEntity", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor" + } + } + }, + "description": "The JSON representation of the ModelEntity resource to be created or updated.", + "required": true, + "x-bodyName": "ModelEntity" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121256,6 +150768,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MonitoredDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MonitoredDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MonitoredDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -121372,7 +150945,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121415,7 +150988,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121435,27 +151008,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/monitoredDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteMonitoredsById", + "/ed-fi/monitoredDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMonitoredsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -121469,48 +151055,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "monitoredDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/monitoredDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getMonitoredsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMonitoredsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -121518,14 +151093,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_MonitoredDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -121537,20 +151112,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "monitoredDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putMonitored", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/monitoredDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteMonitoredsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -121565,18 +151144,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_MonitoredDescriptor" - } - } - }, - "description": "The JSON representation of the Monitored resource to be created or updated.", - "required": true, - "x-bodyName": "Monitored" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -121594,7 +151161,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "monitoredDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getMonitoredsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "monitoredDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putMonitored", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor" + } + } + }, + "description": "The JSON representation of the Monitored resource to be created or updated.", + "required": true, + "x-bodyName": "Monitored" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121819,6 +151501,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -121935,7 +151678,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121978,7 +151721,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121998,27 +151741,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/neglectedOrDelinquentProgramDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteNeglectedOrDelinquentProgramsById", + "/ed-fi/neglectedOrDelinquentProgramDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -122032,48 +151788,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "neglectedOrDelinquentProgramDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/neglectedOrDelinquentProgramDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getNeglectedOrDelinquentProgramsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -122081,14 +151826,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -122100,20 +151845,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "neglectedOrDelinquentProgramDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putNeglectedOrDelinquentProgram", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/neglectedOrDelinquentProgramDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteNeglectedOrDelinquentProgramsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -122128,18 +151877,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor" - } - } - }, - "description": "The JSON representation of the NeglectedOrDelinquentProgram resource to be created or updated.", - "required": true, - "x-bodyName": "NeglectedOrDelinquentProgram" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -122157,7 +151894,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "neglectedOrDelinquentProgramDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getNeglectedOrDelinquentProgramsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "neglectedOrDelinquentProgramDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putNeglectedOrDelinquentProgram", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor" + } + } + }, + "description": "The JSON representation of the NeglectedOrDelinquentProgram resource to be created or updated.", + "required": true, + "x-bodyName": "NeglectedOrDelinquentProgram" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -122382,6 +152234,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -122498,7 +152411,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122541,7 +152454,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -122561,27 +152474,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteNeglectedOrDelinquentProgramServicesById", + "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -122595,48 +152521,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "neglectedOrDelinquentProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getNeglectedOrDelinquentProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -122644,14 +152559,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -122663,20 +152578,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "neglectedOrDelinquentProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putNeglectedOrDelinquentProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteNeglectedOrDelinquentProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -122691,18 +152610,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the NeglectedOrDelinquentProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "NeglectedOrDelinquentProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -122720,7 +152627,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "neglectedOrDelinquentProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getNeglectedOrDelinquentProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "neglectedOrDelinquentProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putNeglectedOrDelinquentProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the NeglectedOrDelinquentProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "NeglectedOrDelinquentProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -122945,6 +152967,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NetworkPurposeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NetworkPurposeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NetworkPurposeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -123061,7 +153144,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123104,7 +153187,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -123124,27 +153207,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/networkPurposeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteNetworkPurposesById", + "/ed-fi/networkPurposeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNetworkPurposesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -123158,48 +153254,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "networkPurposeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/networkPurposeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getNetworkPurposesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNetworkPurposesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -123207,14 +153292,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -123226,20 +153311,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "networkPurposeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putNetworkPurpose", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/networkPurposeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteNetworkPurposesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -123254,18 +153343,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor" - } - } - }, - "description": "The JSON representation of the NetworkPurpose resource to be created or updated.", - "required": true, - "x-bodyName": "NetworkPurpose" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -123283,7 +153360,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "networkPurposeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getNetworkPurposesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "networkPurposeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putNetworkPurpose", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor" + } + } + }, + "description": "The JSON representation of the NetworkPurpose resource to be created or updated.", + "required": true, + "x-bodyName": "NetworkPurpose" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -123508,6 +153700,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -123624,7 +153877,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123667,7 +153920,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -123687,27 +153940,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/nonMedicalImmunizationExemptionDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteNonMedicalImmunizationExemptionsById", + "/ed-fi/nonMedicalImmunizationExemptionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNonMedicalImmunizationExemptionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -123721,48 +153987,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "nonMedicalImmunizationExemptionDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/nonMedicalImmunizationExemptionDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getNonMedicalImmunizationExemptionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNonMedicalImmunizationExemptionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -123770,14 +154025,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -123789,20 +154044,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "nonMedicalImmunizationExemptionDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putNonMedicalImmunizationExemption", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/nonMedicalImmunizationExemptionDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteNonMedicalImmunizationExemptionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -123817,18 +154076,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor" - } - } - }, - "description": "The JSON representation of the NonMedicalImmunizationExemption resource to be created or updated.", - "required": true, - "x-bodyName": "NonMedicalImmunizationExemption" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -123846,7 +154093,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "nonMedicalImmunizationExemptionDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getNonMedicalImmunizationExemptionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "nonMedicalImmunizationExemptionDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putNonMedicalImmunizationExemption", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor" + } + } + }, + "description": "The JSON representation of the NonMedicalImmunizationExemption resource to be created or updated.", + "required": true, + "x-bodyName": "NonMedicalImmunizationExemption" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124133,6 +154495,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ObjectDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ObjectDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ObjectDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -124222,7 +154645,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124265,7 +154688,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124286,27 +154709,40 @@ "Finance" ] }, - "/ed-fi/objectDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteObjectDimensionsById", + "/ed-fi/objectDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getObjectDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -124320,48 +154756,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "objectDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/objectDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getObjectDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getObjectDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -124369,14 +154795,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ObjectDimension" + "items": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -124388,20 +154814,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "objectDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putObjectDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/objectDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteObjectDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -124416,18 +154847,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ObjectDimension" - } - } - }, - "description": "The JSON representation of the ObjectDimension resource to be created or updated.", - "required": true, - "x-bodyName": "ObjectDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -124445,7 +154864,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "objectDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getObjectDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ObjectDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "objectDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putObjectDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ObjectDimension" + } + } + }, + "description": "The JSON representation of the ObjectDimension resource to be created or updated.", + "required": true, + "x-bodyName": "ObjectDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -125267,6 +155801,73 @@ "identificationCode" ], "type": "object" + }, + "EdFi_ObjectiveAssessment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ObjectiveAssessment_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "identificationCode": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "identificationCode", + "namespace" + ], + "type": "object" + }, + "EdFi_ObjectiveAssessment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -125413,7 +156014,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125456,7 +156057,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -125478,27 +156079,40 @@ "AssessmentMetadata" ] }, - "/ed-fi/objectiveAssessments/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteObjectiveAssessmentsById", + "/ed-fi/objectiveAssessments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getObjectiveAssessmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -125512,48 +156126,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "objectiveAssessments" ] }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/objectiveAssessments/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getObjectiveAssessmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getObjectiveAssessmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -125561,14 +156166,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ObjectiveAssessment" + "items": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -125580,20 +156185,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "objectiveAssessments" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putObjectiveAssessment", + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/objectiveAssessments/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteObjectiveAssessmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -125608,18 +156219,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ObjectiveAssessment" - } - } - }, - "description": "The JSON representation of the ObjectiveAssessment resource to be created or updated.", - "required": true, - "x-bodyName": "ObjectiveAssessment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -125637,7 +156236,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "objectiveAssessments" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getObjectiveAssessmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "objectiveAssessments" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putObjectiveAssessment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment" + } + } + }, + "description": "The JSON representation of the ObjectiveAssessment resource to be created or updated.", + "required": true, + "x-bodyName": "ObjectiveAssessment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126143,6 +156857,67 @@ "requisitionNumber" ], "type": "object" + }, + "EdFi_OpenStaffPosition_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OpenStaffPosition_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "requisitionNumber": { + "maxLength": 20, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "requisitionNumber" + ], + "type": "object" + }, + "EdFi_OpenStaffPosition_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -126286,7 +157061,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126329,7 +157104,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126350,27 +157125,40 @@ "Staff" ] }, - "/ed-fi/openStaffPositions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteOpenStaffPositionsById", + "/ed-fi/openStaffPositions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -126384,48 +157172,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "openStaffPositions" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/openStaffPositions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getOpenStaffPositionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -126433,14 +157211,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_OpenStaffPosition" + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -126452,20 +157230,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "openStaffPositions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putOpenStaffPosition", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/openStaffPositions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteOpenStaffPositionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -126480,18 +157263,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_OpenStaffPosition" - } - } - }, - "description": "The JSON representation of the OpenStaffPosition resource to be created or updated.", - "required": true, - "x-bodyName": "OpenStaffPosition" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -126509,7 +157280,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "openStaffPositions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getOpenStaffPositionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "openStaffPositions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putOpenStaffPosition", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition" + } + } + }, + "description": "The JSON representation of the OpenStaffPosition resource to be created or updated.", + "required": true, + "x-bodyName": "OpenStaffPosition" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126756,6 +157642,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_OperationalStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OperationalStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_OperationalStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -126872,7 +157819,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126915,7 +157862,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126935,27 +157882,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/operationalStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteOperationalStatusesById", + "/ed-fi/operationalStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -126969,48 +157929,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "operationalStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/operationalStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getOperationalStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -127018,14 +157967,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -127037,20 +157986,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "operationalStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putOperationalStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/operationalStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteOperationalStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -127065,18 +158018,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor" - } - } - }, - "description": "The JSON representation of the OperationalStatus resource to be created or updated.", - "required": true, - "x-bodyName": "OperationalStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -127094,7 +158035,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "operationalStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getOperationalStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "operationalStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putOperationalStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor" + } + } + }, + "description": "The JSON representation of the OperationalStatus resource to be created or updated.", + "required": true, + "x-bodyName": "OperationalStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127381,6 +158437,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_OperationalUnitDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OperationalUnitDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_OperationalUnitDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -127470,7 +158587,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127513,7 +158630,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127534,27 +158651,40 @@ "Finance" ] }, - "/ed-fi/operationalUnitDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteOperationalUnitDimensionsById", + "/ed-fi/operationalUnitDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalUnitDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -127568,48 +158698,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "operationalUnitDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/operationalUnitDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getOperationalUnitDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalUnitDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -127617,14 +158737,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_OperationalUnitDimension" + "items": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -127636,20 +158756,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "operationalUnitDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putOperationalUnitDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/operationalUnitDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteOperationalUnitDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -127664,18 +158789,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_OperationalUnitDimension" - } - } - }, - "description": "The JSON representation of the OperationalUnitDimension resource to be created or updated.", - "required": true, - "x-bodyName": "OperationalUnitDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -127693,7 +158806,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "operationalUnitDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getOperationalUnitDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "operationalUnitDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putOperationalUnitDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension" + } + } + }, + "description": "The JSON representation of the OperationalUnitDimension resource to be created or updated.", + "required": true, + "x-bodyName": "OperationalUnitDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128992,6 +160220,62 @@ "organizationDepartmentId" ], "type": "object" + }, + "EdFi_OrganizationDepartment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OrganizationDepartment_TrackedChangeKey": { + "properties": { + "organizationDepartmentId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "organizationDepartmentId" + ], + "type": "object" + }, + "EdFi_OrganizationDepartment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -129118,7 +160402,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129161,7 +160445,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129181,6 +160465,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/organizationDepartments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOrganizationDepartmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "organizationDepartments" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/organizationDepartments/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOrganizationDepartmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "organizationDepartments" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/organizationDepartments/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -129216,7 +160618,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129248,15 +160650,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -129283,7 +160676,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129340,7 +160733,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129586,6 +160979,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_OtherNameTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OtherNameTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_OtherNameTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -129702,7 +161156,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129745,7 +161199,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129765,6 +161219,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/otherNameTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOtherNameTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "otherNameTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/otherNameTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOtherNameTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "otherNameTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/otherNameTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -129800,7 +161372,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129832,15 +161404,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -129867,7 +161430,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129924,7 +161487,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130149,6 +161712,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ParticipationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ParticipationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ParticipationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -130265,7 +161889,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130308,7 +161932,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130328,27 +161952,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/participationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteParticipationsById", + "/ed-fi/participationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -130362,48 +161999,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "participationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/participationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getParticipationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -130411,14 +162037,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ParticipationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -130430,20 +162056,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "participationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putParticipation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/participationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteParticipationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -130458,18 +162088,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ParticipationDescriptor" - } - } - }, - "description": "The JSON representation of the Participation resource to be created or updated.", - "required": true, - "x-bodyName": "Participation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -130487,7 +162105,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "participationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getParticipationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "participationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putParticipation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor" + } + } + }, + "description": "The JSON representation of the Participation resource to be created or updated.", + "required": true, + "x-bodyName": "Participation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130712,6 +162445,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ParticipationStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ParticipationStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ParticipationStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -130828,7 +162622,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130871,7 +162665,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130891,27 +162685,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/participationStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteParticipationStatusesById", + "/ed-fi/participationStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -130925,48 +162732,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "participationStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/participationStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getParticipationStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -130974,14 +162770,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -130993,20 +162789,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "participationStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putParticipationStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/participationStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteParticipationStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -131021,18 +162821,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor" - } - } - }, - "description": "The JSON representation of the ParticipationStatus resource to be created or updated.", - "required": true, - "x-bodyName": "ParticipationStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -131050,7 +162838,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "participationStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getParticipationStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "participationStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putParticipationStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor" + } + } + }, + "description": "The JSON representation of the ParticipationStatus resource to be created or updated.", + "required": true, + "x-bodyName": "ParticipationStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131261,6 +163164,67 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "EdFi_Person_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Person_TrackedChangeKey": { + "properties": { + "personId": { + "maxLength": 32, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "personId", + "sourceSystemDescriptor" + ], + "type": "object" + }, + "EdFi_Person_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -131341,7 +163305,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131384,7 +163348,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131406,6 +163370,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/people/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPeopleDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "people" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/people/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPeopleKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "people" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/people/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -131441,7 +163527,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131473,15 +163559,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -131508,7 +163585,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131565,7 +163642,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131767,6 +163844,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PerformanceBaseConversionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -131883,7 +164021,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131926,7 +164064,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131946,6 +164084,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/performanceBaseConversionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceBaseConversionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceBaseConversionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/performanceBaseConversionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceBaseConversionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "performanceBaseConversionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/performanceBaseConversionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -131981,7 +164237,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132013,15 +164269,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -132048,7 +164295,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132105,7 +164352,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132330,6 +164577,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PerformanceLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PerformanceLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -132446,7 +164754,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132489,7 +164797,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132509,27 +164817,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/performanceLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePerformanceLevelsById", + "/ed-fi/performanceLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -132543,48 +164864,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "performanceLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/performanceLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPerformanceLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -132592,14 +164902,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -132611,20 +164921,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "performanceLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPerformanceLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/performanceLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePerformanceLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -132639,18 +164953,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor" - } - } - }, - "description": "The JSON representation of the PerformanceLevel resource to be created or updated.", - "required": true, - "x-bodyName": "PerformanceLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -132668,7 +164970,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "performanceLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPerformanceLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "performanceLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPerformanceLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor" + } + } + }, + "description": "The JSON representation of the PerformanceLevel resource to be created or updated.", + "required": true, + "x-bodyName": "PerformanceLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132893,6 +165310,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PersonalInformationVerificationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -133009,7 +165487,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133052,7 +165530,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133072,27 +165550,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/personalInformationVerificationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePersonalInformationVerificationsById", + "/ed-fi/personalInformationVerificationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPersonalInformationVerificationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -133106,48 +165597,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "personalInformationVerificationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/personalInformationVerificationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPersonalInformationVerificationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPersonalInformationVerificationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -133155,14 +165635,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -133174,20 +165654,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "personalInformationVerificationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPersonalInformationVerification", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/personalInformationVerificationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePersonalInformationVerificationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -133202,18 +165686,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor" - } - } - }, - "description": "The JSON representation of the PersonalInformationVerification resource to be created or updated.", - "required": true, - "x-bodyName": "PersonalInformationVerification" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -133231,7 +165703,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "personalInformationVerificationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPersonalInformationVerificationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "personalInformationVerificationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPersonalInformationVerification", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor" + } + } + }, + "description": "The JSON representation of the PersonalInformationVerification resource to be created or updated.", + "required": true, + "x-bodyName": "PersonalInformationVerification" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133456,6 +166043,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PlatformTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PlatformTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PlatformTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -133572,7 +166220,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133615,7 +166263,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133635,27 +166283,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/platformTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePlatformTypesById", + "/ed-fi/platformTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPlatformTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -133669,48 +166330,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "platformTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/platformTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPlatformTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPlatformTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -133718,14 +166368,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -133737,20 +166387,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "platformTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPlatformType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/platformTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePlatformTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -133765,18 +166419,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor" - } - } - }, - "description": "The JSON representation of the PlatformType resource to be created or updated.", - "required": true, - "x-bodyName": "PlatformType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -133794,7 +166436,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "platformTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPlatformTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "platformTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPlatformType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor" + } + } + }, + "description": "The JSON representation of the PlatformType resource to be created or updated.", + "required": true, + "x-bodyName": "PlatformType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134019,6 +166776,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PopulationServedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PopulationServedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PopulationServedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -134135,7 +166953,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134178,7 +166996,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134198,27 +167016,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/populationServedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePopulationServedsById", + "/ed-fi/populationServedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPopulationServedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -134232,48 +167063,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "populationServedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/populationServedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPopulationServedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPopulationServedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -134281,14 +167101,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -134300,20 +167120,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "populationServedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPopulationServed", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/populationServedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePopulationServedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -134328,18 +167152,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor" - } - } - }, - "description": "The JSON representation of the PopulationServed resource to be created or updated.", - "required": true, - "x-bodyName": "PopulationServed" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -134357,7 +167169,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "populationServedDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPopulationServedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "populationServedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPopulationServed", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor" + } + } + }, + "description": "The JSON representation of the PopulationServed resource to be created or updated.", + "required": true, + "x-bodyName": "PopulationServed" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134582,6 +167509,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -134698,7 +167686,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134741,7 +167729,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134761,27 +167749,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/postSecondaryEventCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePostSecondaryEventCategoriesById", + "/ed-fi/postSecondaryEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -134795,48 +167796,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "postSecondaryEventCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postSecondaryEventCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPostSecondaryEventCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -134844,14 +167834,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -134863,20 +167853,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "postSecondaryEventCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPostSecondaryEventCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postSecondaryEventCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePostSecondaryEventCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -134891,18 +167885,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the PostSecondaryEventCategory resource to be created or updated.", - "required": true, - "x-bodyName": "PostSecondaryEventCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -134920,7 +167902,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "postSecondaryEventCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPostSecondaryEventCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "postSecondaryEventCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPostSecondaryEventCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the PostSecondaryEventCategory resource to be created or updated.", + "required": true, + "x-bodyName": "PostSecondaryEventCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135208,6 +168305,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_PostSecondaryEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryEvent_TrackedChangeKey": { + "properties": { + "eventDate": { + "format": "date", + "type": "string" + }, + "postSecondaryEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "eventDate", + "postSecondaryEventCategoryDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_PostSecondaryEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -135308,7 +168471,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135351,7 +168514,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135372,27 +168535,40 @@ "Graduation" ] }, - "/ed-fi/postSecondaryEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePostSecondaryEventsById", + "/ed-fi/postSecondaryEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -135406,48 +168582,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "postSecondaryEvents" ] }, + "x-Ed-Fi-domains": [ + "Graduation" + ] + }, + "/ed-fi/postSecondaryEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPostSecondaryEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -135455,14 +168621,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryEvent" + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -135474,20 +168640,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "postSecondaryEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPostSecondaryEvent", + "x-Ed-Fi-domains": [ + "Graduation" + ] + }, + "/ed-fi/postSecondaryEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePostSecondaryEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -135502,18 +168673,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryEvent" - } - } - }, - "description": "The JSON representation of the PostSecondaryEvent resource to be created or updated.", - "required": true, - "x-bodyName": "PostSecondaryEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -135531,7 +168690,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "postSecondaryEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPostSecondaryEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "postSecondaryEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPostSecondaryEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent" + } + } + }, + "description": "The JSON representation of the PostSecondaryEvent resource to be created or updated.", + "required": true, + "x-bodyName": "PostSecondaryEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135745,6 +169019,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -135861,7 +169196,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135904,7 +169239,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135924,27 +169259,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/postSecondaryInstitutionLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePostSecondaryInstitutionLevelsById", + "/ed-fi/postSecondaryInstitutionLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -135958,48 +169306,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "postSecondaryInstitutionLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postSecondaryInstitutionLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPostSecondaryInstitutionLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -136007,14 +169344,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -136026,20 +169363,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "postSecondaryInstitutionLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPostSecondaryInstitutionLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postSecondaryInstitutionLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePostSecondaryInstitutionLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -136054,18 +169395,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor" - } - } - }, - "description": "The JSON representation of the PostSecondaryInstitutionLevel resource to be created or updated.", - "required": true, - "x-bodyName": "PostSecondaryInstitutionLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -136083,7 +169412,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "postSecondaryInstitutionLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPostSecondaryInstitutionLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "postSecondaryInstitutionLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPostSecondaryInstitutionLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor" + } + } + }, + "description": "The JSON representation of the PostSecondaryInstitutionLevel resource to be created or updated.", + "required": true, + "x-bodyName": "PostSecondaryInstitutionLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137444,6 +170888,62 @@ "postSecondaryInstitutionId" ], "type": "object" + }, + "EdFi_PostSecondaryInstitution_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitution_TrackedChangeKey": { + "properties": { + "postSecondaryInstitutionId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "postSecondaryInstitutionId" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitution_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -137569,7 +171069,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137612,7 +171112,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137634,27 +171134,40 @@ "Graduation" ] }, - "/ed-fi/postSecondaryInstitutions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePostSecondaryInstitutionsById", + "/ed-fi/postSecondaryInstitutions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -137668,48 +171181,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "postSecondaryInstitutions" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Graduation" + ] + }, + "/ed-fi/postSecondaryInstitutions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPostSecondaryInstitutionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -137717,14 +171221,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution" + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -137736,20 +171240,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "postSecondaryInstitutions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPostSecondaryInstitution", + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Graduation" + ] + }, + "/ed-fi/postSecondaryInstitutions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePostSecondaryInstitutionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -137764,18 +171274,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution" - } - } - }, - "description": "The JSON representation of the PostSecondaryInstitution resource to be created or updated.", - "required": true, - "x-bodyName": "PostSecondaryInstitution" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -137793,7 +171291,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "postSecondaryInstitutions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPostSecondaryInstitutionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "postSecondaryInstitutions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPostSecondaryInstitution", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution" + } + } + }, + "description": "The JSON representation of the PostSecondaryInstitution resource to be created or updated.", + "required": true, + "x-bodyName": "PostSecondaryInstitution" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138040,6 +171653,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PostingResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostingResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PostingResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -138156,7 +171830,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138199,7 +171873,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138219,27 +171893,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/postingResultDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePostingResultsById", + "/ed-fi/postingResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostingResultsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -138253,48 +171940,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "postingResultDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postingResultDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPostingResultsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostingResultsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -138302,14 +171978,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PostingResultDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -138321,20 +171997,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "postingResultDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPostingResult", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postingResultDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePostingResultsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -138349,18 +172029,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PostingResultDescriptor" - } - } - }, - "description": "The JSON representation of the PostingResult resource to be created or updated.", - "required": true, - "x-bodyName": "PostingResult" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -138378,7 +172046,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "postingResultDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPostingResultsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "postingResultDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPostingResult", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor" + } + } + }, + "description": "The JSON representation of the PostingResult resource to be created or updated.", + "required": true, + "x-bodyName": "PostingResult" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138603,6 +172386,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -138719,7 +172563,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138762,7 +172606,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138782,27 +172626,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/primaryLearningDeviceAccessDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePrimaryLearningDeviceAccessesById", + "/ed-fi/primaryLearningDeviceAccessDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAccessesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -138816,48 +172673,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "primaryLearningDeviceAccessDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceAccessDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPrimaryLearningDeviceAccessesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAccessesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -138865,14 +172711,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -138884,20 +172730,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "primaryLearningDeviceAccessDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPrimaryLearningDeviceAccess", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceAccessDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePrimaryLearningDeviceAccessesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -138912,18 +172762,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor" - } - } - }, - "description": "The JSON representation of the PrimaryLearningDeviceAccess resource to be created or updated.", - "required": true, - "x-bodyName": "PrimaryLearningDeviceAccess" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -138941,7 +172779,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "primaryLearningDeviceAccessDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPrimaryLearningDeviceAccessesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "primaryLearningDeviceAccessDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPrimaryLearningDeviceAccess", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor" + } + } + }, + "description": "The JSON representation of the PrimaryLearningDeviceAccess resource to be created or updated.", + "required": true, + "x-bodyName": "PrimaryLearningDeviceAccess" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139166,6 +173119,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -139282,7 +173296,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139325,7 +173339,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139345,27 +173359,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePrimaryLearningDeviceAwayFromSchoolsById", + "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAwayFromSchoolsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -139379,48 +173406,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "primaryLearningDeviceAwayFromSchoolDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPrimaryLearningDeviceAwayFromSchoolsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAwayFromSchoolsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -139428,14 +173444,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -139447,20 +173463,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "primaryLearningDeviceAwayFromSchoolDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPrimaryLearningDeviceAwayFromSchool", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePrimaryLearningDeviceAwayFromSchoolsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -139475,18 +173495,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor" - } - } - }, - "description": "The JSON representation of the PrimaryLearningDeviceAwayFromSchool resource to be created or updated.", - "required": true, - "x-bodyName": "PrimaryLearningDeviceAwayFromSchool" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -139504,7 +173512,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "primaryLearningDeviceAwayFromSchoolDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPrimaryLearningDeviceAwayFromSchoolsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "primaryLearningDeviceAwayFromSchoolDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPrimaryLearningDeviceAwayFromSchool", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor" + } + } + }, + "description": "The JSON representation of the PrimaryLearningDeviceAwayFromSchool resource to be created or updated.", + "required": true, + "x-bodyName": "PrimaryLearningDeviceAwayFromSchool" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139729,6 +173852,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -139845,7 +174029,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139888,7 +174072,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139908,27 +174092,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/primaryLearningDeviceProviderDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePrimaryLearningDeviceProvidersById", + "/ed-fi/primaryLearningDeviceProviderDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceProvidersDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -139942,48 +174139,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "primaryLearningDeviceProviderDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceProviderDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPrimaryLearningDeviceProvidersById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceProvidersKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -139991,14 +174177,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -140010,20 +174196,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "primaryLearningDeviceProviderDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPrimaryLearningDeviceProvider", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceProviderDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePrimaryLearningDeviceProvidersById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -140038,18 +174228,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor" - } - } - }, - "description": "The JSON representation of the PrimaryLearningDeviceProvider resource to be created or updated.", - "required": true, - "x-bodyName": "PrimaryLearningDeviceProvider" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -140067,7 +174245,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "primaryLearningDeviceProviderDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPrimaryLearningDeviceProvidersById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "primaryLearningDeviceProviderDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPrimaryLearningDeviceProvider", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor" + } + } + }, + "description": "The JSON representation of the PrimaryLearningDeviceProvider resource to be created or updated.", + "required": true, + "x-bodyName": "PrimaryLearningDeviceProvider" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -140292,6 +174585,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProficiencyDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProficiencyDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProficiencyDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -140408,7 +174762,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -140451,7 +174805,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -140471,27 +174825,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/proficiencyDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProficienciesById", + "/ed-fi/proficiencyDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProficienciesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -140505,48 +174872,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "proficiencyDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/proficiencyDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProficienciesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProficienciesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -140554,14 +174910,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -140573,20 +174929,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "proficiencyDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProficiency", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/proficiencyDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProficienciesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -140601,18 +174961,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor" - } - } - }, - "description": "The JSON representation of the Proficiency resource to be created or updated.", - "required": true, - "x-bodyName": "Proficiency" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -140630,7 +174978,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "proficiencyDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProficienciesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "proficiencyDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProficiency", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor" + } + } + }, + "description": "The JSON representation of the Proficiency resource to be created or updated.", + "required": true, + "x-bodyName": "Proficiency" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -140855,6 +175318,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramAssignmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramAssignmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramAssignmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -140971,7 +175495,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141014,7 +175538,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141034,27 +175558,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programAssignmentDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramAssignmentsById", + "/ed-fi/programAssignmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramAssignmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -141068,48 +175605,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programAssignmentDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programAssignmentDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramAssignmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramAssignmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -141117,14 +175643,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -141136,20 +175662,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programAssignmentDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramAssignment", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programAssignmentDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramAssignmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -141164,18 +175694,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramAssignment resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramAssignment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -141193,7 +175711,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programAssignmentDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramAssignmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programAssignmentDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramAssignment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramAssignment resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramAssignment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141418,6 +176051,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -141534,7 +176228,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141577,7 +176271,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141597,27 +176291,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programCharacteristicDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramCharacteristicsById", + "/ed-fi/programCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramCharacteristicsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -141631,48 +176338,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programCharacteristicDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programCharacteristicDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramCharacteristicsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramCharacteristicsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -141680,14 +176376,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -141699,20 +176395,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programCharacteristicDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramCharacteristic", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programCharacteristicDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramCharacteristicsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -141727,18 +176427,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramCharacteristic resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramCharacteristic" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -141756,7 +176444,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programCharacteristicDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramCharacteristicsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programCharacteristicDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramCharacteristic", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramCharacteristic resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramCharacteristic" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142043,6 +176846,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ProgramDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ProgramDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -142132,7 +176996,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142175,7 +177039,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142196,27 +177060,40 @@ "Finance" ] }, - "/ed-fi/programDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramDimensionsById", + "/ed-fi/programDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -142230,48 +177107,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/programDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -142279,14 +177146,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramDimension" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -142298,20 +177165,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/programDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -142326,18 +177198,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramDimension" - } - } - }, - "description": "The JSON representation of the ProgramDimension resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -142355,7 +177215,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramDimension" + } + } + }, + "description": "The JSON representation of the ProgramDimension resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142968,6 +177943,92 @@ "programEvaluationElementTitle" ], "type": "object" + }, + "EdFi_ProgramEvaluationElement_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationElement_TrackedChangeKey": { + "properties": { + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationElementTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "programEducationOrganizationId", + "programEvaluationElementTitle", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationElement_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -143144,7 +178205,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143187,7 +178248,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -143208,27 +178269,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/programEvaluationElements/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramEvaluationElementsById", + "/ed-fi/programEvaluationElements/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationElementsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -143242,48 +178316,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programEvaluationElements" ] }, + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationElements/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramEvaluationElementsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationElementsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -143291,14 +178355,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -143310,20 +178374,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programEvaluationElements" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramEvaluationElement", + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationElements/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramEvaluationElementsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -143338,18 +178407,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement" - } - } - }, - "description": "The JSON representation of the ProgramEvaluationElement resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramEvaluationElement" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -143367,7 +178424,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programEvaluationElements" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramEvaluationElementsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programEvaluationElements" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramEvaluationElement", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement" + } + } + }, + "description": "The JSON representation of the ProgramEvaluationElement resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramEvaluationElement" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -143918,6 +179090,92 @@ "programEvaluationObjectiveTitle" ], "type": "object" + }, + "EdFi_ProgramEvaluationObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationObjective_TrackedChangeKey": { + "properties": { + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationObjectiveTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "programEducationOrganizationId", + "programEvaluationObjectiveTitle", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -144084,7 +179342,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144127,7 +179385,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144148,27 +179406,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/programEvaluationObjectives/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramEvaluationObjectivesById", + "/ed-fi/programEvaluationObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationObjectivesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -144182,48 +179453,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programEvaluationObjectives" ] }, + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationObjectives/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramEvaluationObjectivesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationObjectivesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -144231,14 +179492,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -144250,20 +179511,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programEvaluationObjectives" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramEvaluationObjective", + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationObjectives/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramEvaluationObjectivesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -144278,18 +179544,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective" - } - } - }, - "description": "The JSON representation of the ProgramEvaluationObjective resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramEvaluationObjective" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -144307,7 +179561,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programEvaluationObjectives" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramEvaluationObjectivesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programEvaluationObjectives" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramEvaluationObjective", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective" + } + } + }, + "description": "The JSON representation of the ProgramEvaluationObjective resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramEvaluationObjective" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144573,6 +179942,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -144689,7 +180119,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144732,7 +180162,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144752,27 +180182,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programEvaluationPeriodDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramEvaluationPeriodsById", + "/ed-fi/programEvaluationPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationPeriodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -144786,48 +180229,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programEvaluationPeriodDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programEvaluationPeriodDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramEvaluationPeriodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationPeriodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -144835,14 +180267,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -144854,20 +180286,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programEvaluationPeriodDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramEvaluationPeriod", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programEvaluationPeriodDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramEvaluationPeriodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -144882,18 +180318,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramEvaluationPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramEvaluationPeriod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -144911,7 +180335,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programEvaluationPeriodDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramEvaluationPeriodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programEvaluationPeriodDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramEvaluationPeriod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramEvaluationPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramEvaluationPeriod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145136,6 +180675,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -145252,7 +180852,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145295,7 +180895,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145315,27 +180915,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programEvaluationTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramEvaluationTypesById", + "/ed-fi/programEvaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -145349,48 +180962,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programEvaluationTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programEvaluationTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramEvaluationTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -145398,14 +181000,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -145417,20 +181019,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programEvaluationTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramEvaluationType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programEvaluationTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramEvaluationTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -145445,18 +181051,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramEvaluationType resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramEvaluationType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -145474,7 +181068,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programEvaluationTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramEvaluationTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programEvaluationTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramEvaluationType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramEvaluationType resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramEvaluationType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145963,6 +181672,87 @@ "programEvaluationTypeDescriptor" ], "type": "object" + }, + "EdFi_ProgramEvaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluation_TrackedChangeKey": { + "properties": { + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "programEducationOrganizationId", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_ProgramEvaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -146110,7 +181900,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146153,7 +181943,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146174,27 +181964,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/programEvaluations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramEvaluationsById", + "/ed-fi/programEvaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -146208,48 +182011,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programEvaluations" ] }, + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramEvaluationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -146257,14 +182050,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluation" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -146276,20 +182069,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programEvaluations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramEvaluation", + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramEvaluationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -146304,18 +182102,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluation" - } - } - }, - "description": "The JSON representation of the ProgramEvaluation resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramEvaluation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -146333,7 +182119,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programEvaluations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramEvaluationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programEvaluations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramEvaluation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation" + } + } + }, + "description": "The JSON representation of the ProgramEvaluation resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramEvaluation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146586,6 +182487,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramSponsorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramSponsorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramSponsorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -146702,7 +182664,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146745,7 +182707,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146765,27 +182727,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programSponsorDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramSponsorsById", + "/ed-fi/programSponsorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramSponsorsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -146799,48 +182774,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programSponsorDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programSponsorDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramSponsorsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramSponsorsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -146848,14 +182812,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -146867,20 +182831,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programSponsorDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramSponsor", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programSponsorDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramSponsorsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -146895,18 +182863,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramSponsor resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramSponsor" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -146924,7 +182880,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programSponsorDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramSponsorsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programSponsorDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramSponsor", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramSponsor resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramSponsor" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147149,6 +183220,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -147265,7 +183397,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147308,7 +183440,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147328,27 +183460,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramTypesById", + "/ed-fi/programTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -147362,48 +183507,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -147411,14 +183545,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -147430,20 +183564,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -147458,18 +183596,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramType resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -147487,7 +183613,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramType resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147942,6 +184183,72 @@ "programTypeDescriptor" ], "type": "object" + }, + "EdFi_Program_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Program_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_Program_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -148041,7 +184348,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148084,7 +184391,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148115,27 +184422,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/programs/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramsById", + "/ed-fi/programs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -148149,48 +184469,48 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programs" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programs/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -148198,14 +184518,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Program" + "items": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -148217,20 +184537,35 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programs" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgram", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programs/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -148245,18 +184580,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Program" - } - } - }, - "description": "The JSON representation of the Program resource to be created or updated.", - "required": true, - "x-bodyName": "Program" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -148274,7 +184597,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programs" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Program" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programs" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgram", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Program" + } + } + }, + "description": "The JSON representation of the Program resource to be created or updated.", + "required": true, + "x-bodyName": "Program" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148507,6 +184945,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgressDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgressDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgressDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -148623,7 +185122,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148666,7 +185165,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148686,27 +185185,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/progressDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgressesById", + "/ed-fi/progressDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgressesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -148720,48 +185232,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "progressDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/progressDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgressesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgressesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -148769,14 +185270,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgressDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -148788,20 +185289,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "progressDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgress", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/progressDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgressesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -148816,18 +185321,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgressDescriptor" - } - } - }, - "description": "The JSON representation of the Progress resource to be created or updated.", - "required": true, - "x-bodyName": "Progress" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -148845,7 +185338,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "progressDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgressesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "progressDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgress", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor" + } + } + }, + "description": "The JSON representation of the Progress resource to be created or updated.", + "required": true, + "x-bodyName": "Progress" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149070,6 +185678,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgressLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgressLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgressLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -149186,7 +185855,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149229,7 +185898,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149249,27 +185918,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/progressLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgressLevelsById", + "/ed-fi/progressLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgressLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -149283,48 +185965,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "progressLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/progressLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgressLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgressLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -149332,14 +186003,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -149351,20 +186022,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "progressLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgressLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/progressLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgressLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -149379,18 +186054,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor" - } - } - }, - "description": "The JSON representation of the ProgressLevel resource to be created or updated.", - "required": true, - "x-bodyName": "ProgressLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -149408,7 +186071,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "progressLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgressLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "progressLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgressLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor" + } + } + }, + "description": "The JSON representation of the ProgressLevel resource to be created or updated.", + "required": true, + "x-bodyName": "ProgressLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149695,6 +186473,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ProjectDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProjectDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ProjectDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -149784,7 +186623,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149827,7 +186666,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149848,27 +186687,40 @@ "Finance" ] }, - "/ed-fi/projectDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProjectDimensionsById", + "/ed-fi/projectDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProjectDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -149882,48 +186734,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "projectDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/projectDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProjectDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProjectDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -149931,14 +186773,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProjectDimension" + "items": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -149950,20 +186792,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "projectDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProjectDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/projectDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProjectDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -149978,18 +186825,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProjectDimension" - } - } - }, - "description": "The JSON representation of the ProjectDimension resource to be created or updated.", - "required": true, - "x-bodyName": "ProjectDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -150007,7 +186842,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "projectDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProjectDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProjectDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "projectDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProjectDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProjectDimension" + } + } + }, + "description": "The JSON representation of the ProjectDimension resource to be created or updated.", + "required": true, + "x-bodyName": "ProjectDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150214,6 +187164,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProviderCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProviderCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProviderCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -150330,7 +187341,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150373,7 +187384,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150393,27 +187404,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/providerCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProviderCategoriesById", + "/ed-fi/providerCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProviderCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -150427,48 +187451,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "providerCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProviderCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProviderCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -150476,14 +187489,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -150495,20 +187508,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "providerCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProviderCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProviderCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -150523,18 +187540,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the ProviderCategory resource to be created or updated.", - "required": true, - "x-bodyName": "ProviderCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -150552,7 +187557,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "providerCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProviderCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "providerCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProviderCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the ProviderCategory resource to be created or updated.", + "required": true, + "x-bodyName": "ProviderCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150777,6 +187897,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProviderProfitabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProviderProfitabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -150893,7 +188074,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150936,7 +188117,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150956,27 +188137,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/providerProfitabilityDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProviderProfitabilitiesById", + "/ed-fi/providerProfitabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProviderProfitabilitiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -150990,48 +188184,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "providerProfitabilityDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerProfitabilityDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProviderProfitabilitiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProviderProfitabilitiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -151039,14 +188222,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -151058,20 +188241,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "providerProfitabilityDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProviderProfitability", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerProfitabilityDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProviderProfitabilitiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -151086,18 +188273,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor" - } - } - }, - "description": "The JSON representation of the ProviderProfitability resource to be created or updated.", - "required": true, - "x-bodyName": "ProviderProfitability" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -151115,7 +188290,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "providerProfitabilityDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProviderProfitabilitiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "providerProfitabilityDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProviderProfitability", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor" + } + } + }, + "description": "The JSON representation of the ProviderProfitability resource to be created or updated.", + "required": true, + "x-bodyName": "ProviderProfitability" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151340,6 +188630,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProviderStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProviderStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProviderStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -151456,7 +188807,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151499,7 +188850,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151519,27 +188870,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/providerStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProviderStatusesById", + "/ed-fi/providerStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProviderStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -151553,48 +188917,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "providerStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProviderStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProviderStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -151602,14 +188955,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -151621,20 +188974,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "providerStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProviderStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProviderStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -151649,18 +189006,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor" - } - } - }, - "description": "The JSON representation of the ProviderStatus resource to be created or updated.", - "required": true, - "x-bodyName": "ProviderStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -151678,7 +189023,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "providerStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProviderStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "providerStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProviderStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor" + } + } + }, + "description": "The JSON representation of the ProviderStatus resource to be created or updated.", + "required": true, + "x-bodyName": "ProviderStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151903,6 +189363,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PublicationStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PublicationStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PublicationStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -152019,7 +189540,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152062,7 +189583,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152082,27 +189603,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/publicationStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePublicationStatusesById", + "/ed-fi/publicationStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPublicationStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -152116,48 +189650,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "publicationStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/publicationStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPublicationStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPublicationStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -152165,14 +189688,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -152184,20 +189707,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "publicationStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPublicationStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/publicationStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePublicationStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -152212,18 +189739,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor" - } - } - }, - "description": "The JSON representation of the PublicationStatus resource to be created or updated.", - "required": true, - "x-bodyName": "PublicationStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -152241,7 +189756,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "publicationStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPublicationStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "publicationStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPublicationStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor" + } + } + }, + "description": "The JSON representation of the PublicationStatus resource to be created or updated.", + "required": true, + "x-bodyName": "PublicationStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152466,6 +190096,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_QuestionFormDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_QuestionFormDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_QuestionFormDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -152582,7 +190273,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152625,7 +190316,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152645,27 +190336,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/questionFormDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteQuestionFormsById", + "/ed-fi/questionFormDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getQuestionFormsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -152679,48 +190383,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "questionFormDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/questionFormDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getQuestionFormsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getQuestionFormsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -152728,14 +190421,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -152747,20 +190440,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "questionFormDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putQuestionForm", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/questionFormDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteQuestionFormsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -152775,18 +190472,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor" - } - } - }, - "description": "The JSON representation of the QuestionForm resource to be created or updated.", - "required": true, - "x-bodyName": "QuestionForm" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -152804,7 +190489,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "questionFormDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getQuestionFormsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "questionFormDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putQuestionForm", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor" + } + } + }, + "description": "The JSON representation of the QuestionForm resource to be created or updated.", + "required": true, + "x-bodyName": "QuestionForm" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153029,6 +190829,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RaceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RaceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RaceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -153145,7 +191006,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153188,7 +191049,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153208,27 +191069,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/raceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRacesById", + "/ed-fi/raceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRacesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -153242,48 +191116,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "raceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/raceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRacesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRacesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -153291,14 +191154,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RaceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -153310,20 +191173,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "raceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRace", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/raceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRacesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -153338,18 +191205,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RaceDescriptor" - } - } - }, - "description": "The JSON representation of the Race resource to be created or updated.", - "required": true, - "x-bodyName": "Race" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -153367,7 +191222,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "raceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRacesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "raceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRace", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor" + } + } + }, + "description": "The JSON representation of the Race resource to be created or updated.", + "required": true, + "x-bodyName": "Race" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153592,6 +191562,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -153708,7 +191739,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153751,7 +191782,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153771,27 +191802,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/ratingLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRatingLevelsById", + "/ed-fi/ratingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRatingLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -153805,48 +191849,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "ratingLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ratingLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRatingLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRatingLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -153854,14 +191887,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -153873,20 +191906,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "ratingLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRatingLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ratingLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRatingLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -153901,18 +191938,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor" - } - } - }, - "description": "The JSON representation of the RatingLevel resource to be created or updated.", - "required": true, - "x-bodyName": "RatingLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -153930,7 +191955,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "ratingLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRatingLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "ratingLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRatingLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor" + } + } + }, + "description": "The JSON representation of the RatingLevel resource to be created or updated.", + "required": true, + "x-bodyName": "RatingLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154155,6 +192295,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReasonExitedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReasonExitedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReasonExitedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -154271,7 +192472,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154314,7 +192515,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154334,27 +192535,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/reasonExitedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteReasonExitedsById", + "/ed-fi/reasonExitedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReasonExitedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -154368,48 +192582,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "reasonExitedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reasonExitedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getReasonExitedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReasonExitedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -154417,14 +192620,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -154436,20 +192639,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "reasonExitedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putReasonExited", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reasonExitedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteReasonExitedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -154464,18 +192671,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor" - } - } - }, - "description": "The JSON representation of the ReasonExited resource to be created or updated.", - "required": true, - "x-bodyName": "ReasonExited" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -154493,7 +192688,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "reasonExitedDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getReasonExitedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "reasonExitedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putReasonExited", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor" + } + } + }, + "description": "The JSON representation of the ReasonExited resource to be created or updated.", + "required": true, + "x-bodyName": "ReasonExited" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154718,6 +193028,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReasonNotTestedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReasonNotTestedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReasonNotTestedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -154834,7 +193205,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154877,7 +193248,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154897,27 +193268,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/reasonNotTestedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteReasonNotTestedsById", + "/ed-fi/reasonNotTestedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReasonNotTestedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -154931,48 +193315,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "reasonNotTestedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reasonNotTestedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getReasonNotTestedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReasonNotTestedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -154980,14 +193353,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -154999,20 +193372,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "reasonNotTestedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putReasonNotTested", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reasonNotTestedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteReasonNotTestedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -155027,18 +193404,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor" - } - } - }, - "description": "The JSON representation of the ReasonNotTested resource to be created or updated.", - "required": true, - "x-bodyName": "ReasonNotTested" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -155056,7 +193421,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "reasonNotTestedDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getReasonNotTestedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "reasonNotTestedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putReasonNotTested", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor" + } + } + }, + "description": "The JSON representation of the ReasonNotTested resource to be created or updated.", + "required": true, + "x-bodyName": "ReasonNotTested" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -155281,6 +193761,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RecognitionTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RecognitionTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RecognitionTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -155397,7 +193938,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155440,7 +193981,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -155460,27 +194001,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/recognitionTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRecognitionTypesById", + "/ed-fi/recognitionTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRecognitionTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -155494,48 +194048,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "recognitionTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/recognitionTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRecognitionTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRecognitionTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -155543,14 +194086,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -155562,20 +194105,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "recognitionTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRecognitionType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/recognitionTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRecognitionTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -155590,18 +194137,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor" - } - } - }, - "description": "The JSON representation of the RecognitionType resource to be created or updated.", - "required": true, - "x-bodyName": "RecognitionType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -155619,7 +194154,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "recognitionTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRecognitionTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "recognitionTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRecognitionType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor" + } + } + }, + "description": "The JSON representation of the RecognitionType resource to be created or updated.", + "required": true, + "x-bodyName": "RecognitionType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -155844,6 +194494,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RelationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RelationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RelationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -155960,7 +194671,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156003,7 +194714,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156023,27 +194734,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/relationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRelationsById", + "/ed-fi/relationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRelationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -156057,48 +194781,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "relationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/relationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRelationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRelationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -156106,14 +194819,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RelationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -156125,20 +194838,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "relationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRelation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/relationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRelationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -156153,18 +194870,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RelationDescriptor" - } - } - }, - "description": "The JSON representation of the Relation resource to be created or updated.", - "required": true, - "x-bodyName": "Relation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -156182,7 +194887,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "relationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRelationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "relationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRelation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor" + } + } + }, + "description": "The JSON representation of the Relation resource to be created or updated.", + "required": true, + "x-bodyName": "Relation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156407,6 +195227,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RepeatIdentifierDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RepeatIdentifierDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RepeatIdentifierDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -156523,7 +195404,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156566,7 +195447,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156586,27 +195467,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/repeatIdentifierDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRepeatIdentifiersById", + "/ed-fi/repeatIdentifierDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRepeatIdentifiersDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -156620,48 +195514,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "repeatIdentifierDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/repeatIdentifierDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRepeatIdentifiersById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRepeatIdentifiersKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -156669,14 +195552,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -156688,20 +195571,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "repeatIdentifierDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRepeatIdentifier", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/repeatIdentifierDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRepeatIdentifiersById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -156716,18 +195603,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor" - } - } - }, - "description": "The JSON representation of the RepeatIdentifier resource to be created or updated.", - "required": true, - "x-bodyName": "RepeatIdentifier" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -156745,7 +195620,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "repeatIdentifierDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRepeatIdentifiersById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "repeatIdentifierDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRepeatIdentifier", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor" + } + } + }, + "description": "The JSON representation of the RepeatIdentifier resource to be created or updated.", + "required": true, + "x-bodyName": "RepeatIdentifier" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157650,6 +196640,87 @@ "studentCompetencyObjectiveReference" ], "type": "object" + }, + "EdFi_ReportCard_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReportCard_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "type": "string" + }, + "gradingPeriodSchoolId": { + "format": "int64", + "type": "integer" + }, + "gradingPeriodSchoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolId", + "gradingPeriodSchoolYear", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_ReportCard_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -157797,7 +196868,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157840,7 +196911,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157862,27 +196933,40 @@ "ReportCard" ] }, - "/ed-fi/reportCards/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteReportCardsById", + "/ed-fi/reportCards/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReportCardsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -157896,48 +196980,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "reportCards" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/reportCards/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getReportCardsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReportCardsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -157945,14 +197020,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ReportCard" + "items": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -157964,20 +197039,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "reportCards" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putReportCard", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/reportCards/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteReportCardsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -157992,18 +197073,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ReportCard" - } - } - }, - "description": "The JSON representation of the ReportCard resource to be created or updated.", - "required": true, - "x-bodyName": "ReportCard" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -158021,7 +197090,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "reportCards" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getReportCardsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReportCard" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "reportCards" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putReportCard", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReportCard" + } + } + }, + "description": "The JSON representation of the ReportCard resource to be created or updated.", + "required": true, + "x-bodyName": "ReportCard" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158275,6 +197459,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReporterDescriptionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReporterDescriptionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReporterDescriptionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -158391,7 +197636,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158434,7 +197679,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158454,27 +197699,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/reporterDescriptionDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteReporterDescriptionsById", + "/ed-fi/reporterDescriptionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReporterDescriptionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -158488,48 +197746,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "reporterDescriptionDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reporterDescriptionDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getReporterDescriptionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReporterDescriptionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -158537,14 +197784,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -158556,20 +197803,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "reporterDescriptionDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putReporterDescription", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reporterDescriptionDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteReporterDescriptionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -158584,18 +197835,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor" - } - } - }, - "description": "The JSON representation of the ReporterDescription resource to be created or updated.", - "required": true, - "x-bodyName": "ReporterDescription" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -158613,7 +197852,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "reporterDescriptionDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getReporterDescriptionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "reporterDescriptionDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putReporterDescription", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor" + } + } + }, + "description": "The JSON representation of the ReporterDescription resource to be created or updated.", + "required": true, + "x-bodyName": "ReporterDescription" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158838,6 +198192,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReportingTagDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReportingTagDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReportingTagDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -158954,7 +198369,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158997,7 +198412,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159017,27 +198432,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/reportingTagDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteReportingTagsById", + "/ed-fi/reportingTagDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReportingTagsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -159051,48 +198479,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "reportingTagDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reportingTagDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getReportingTagsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReportingTagsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -159100,14 +198517,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -159119,20 +198536,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "reportingTagDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putReportingTag", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reportingTagDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteReportingTagsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -159147,18 +198568,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor" - } - } - }, - "description": "The JSON representation of the ReportingTag resource to be created or updated.", - "required": true, - "x-bodyName": "ReportingTag" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -159176,7 +198585,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "reportingTagDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getReportingTagsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "reportingTagDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putReportingTag", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor" + } + } + }, + "description": "The JSON representation of the ReportingTag resource to be created or updated.", + "required": true, + "x-bodyName": "ReportingTag" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159401,6 +198925,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResidencyStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResidencyStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResidencyStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -159517,7 +199102,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159560,7 +199145,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159580,27 +199165,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/residencyStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteResidencyStatusesById", + "/ed-fi/residencyStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResidencyStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -159614,48 +199212,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "residencyStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/residencyStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getResidencyStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResidencyStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -159663,14 +199250,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -159682,20 +199269,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "residencyStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putResidencyStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/residencyStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteResidencyStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -159710,18 +199301,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor" - } - } - }, - "description": "The JSON representation of the ResidencyStatus resource to be created or updated.", - "required": true, - "x-bodyName": "ResidencyStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -159739,7 +199318,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "residencyStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getResidencyStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "residencyStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putResidencyStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor" + } + } + }, + "description": "The JSON representation of the ResidencyStatus resource to be created or updated.", + "required": true, + "x-bodyName": "ResidencyStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159964,6 +199658,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResponseIndicatorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResponseIndicatorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResponseIndicatorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -160080,7 +199835,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -160123,7 +199878,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -160143,27 +199898,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/responseIndicatorDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteResponseIndicatorsById", + "/ed-fi/responseIndicatorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResponseIndicatorsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -160177,48 +199945,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "responseIndicatorDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/responseIndicatorDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getResponseIndicatorsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResponseIndicatorsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -160226,14 +199983,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -160245,20 +200002,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "responseIndicatorDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putResponseIndicator", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/responseIndicatorDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteResponseIndicatorsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -160273,18 +200034,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor" - } - } - }, - "description": "The JSON representation of the ResponseIndicator resource to be created or updated.", - "required": true, - "x-bodyName": "ResponseIndicator" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -160302,7 +200051,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "responseIndicatorDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getResponseIndicatorsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "responseIndicatorDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putResponseIndicator", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor" + } + } + }, + "description": "The JSON representation of the ResponseIndicator resource to be created or updated.", + "required": true, + "x-bodyName": "ResponseIndicator" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -160527,6 +200391,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResponsibilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResponsibilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResponsibilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -160643,7 +200568,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -160686,7 +200611,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -160706,27 +200631,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/responsibilityDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteResponsibilitiesById", + "/ed-fi/responsibilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResponsibilitiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -160740,48 +200678,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "responsibilityDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/responsibilityDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getResponsibilitiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResponsibilitiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -160789,14 +200716,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -160808,20 +200735,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "responsibilityDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putResponsibility", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/responsibilityDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteResponsibilitiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -160836,18 +200767,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor" - } - } - }, - "description": "The JSON representation of the Responsibility resource to be created or updated.", - "required": true, - "x-bodyName": "Responsibility" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -160865,7 +200784,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "responsibilityDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getResponsibilitiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "responsibilityDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putResponsibility", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor" + } + } + }, + "description": "The JSON representation of the Responsibility resource to be created or updated.", + "required": true, + "x-bodyName": "Responsibility" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -161090,6 +201124,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RestraintEventReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RestraintEventReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RestraintEventReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -161206,7 +201301,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -161249,7 +201344,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -161269,27 +201364,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/restraintEventReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRestraintEventReasonsById", + "/ed-fi/restraintEventReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -161303,48 +201411,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "restraintEventReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/restraintEventReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRestraintEventReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -161352,14 +201449,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -161371,20 +201468,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "restraintEventReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRestraintEventReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/restraintEventReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRestraintEventReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -161399,18 +201500,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor" - } - } - }, - "description": "The JSON representation of the RestraintEventReason resource to be created or updated.", - "required": true, - "x-bodyName": "RestraintEventReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -161428,7 +201517,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "restraintEventReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRestraintEventReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "restraintEventReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRestraintEventReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor" + } + } + }, + "description": "The JSON representation of the RestraintEventReason resource to be created or updated.", + "required": true, + "x-bodyName": "RestraintEventReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -161877,6 +202081,72 @@ "restraintEventReasonDescriptor" ], "type": "object" + }, + "EdFi_RestraintEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RestraintEvent_TrackedChangeKey": { + "properties": { + "restraintEventIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "restraintEventIdentifier", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_RestraintEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -161985,7 +202255,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162028,7 +202298,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162049,27 +202319,40 @@ "SpecialEducation" ] }, - "/ed-fi/restraintEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRestraintEventsById", + "/ed-fi/restraintEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -162083,48 +202366,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "restraintEvents" ] }, + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, + "/ed-fi/restraintEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRestraintEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -162132,14 +202405,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RestraintEvent" + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -162151,20 +202424,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "restraintEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRestraintEvent", + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, + "/ed-fi/restraintEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRestraintEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -162179,18 +202457,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RestraintEvent" - } - } - }, - "description": "The JSON representation of the RestraintEvent resource to be created or updated.", - "required": true, - "x-bodyName": "RestraintEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -162208,7 +202474,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "restraintEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRestraintEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RestraintEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "restraintEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRestraintEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RestraintEvent" + } + } + }, + "description": "The JSON representation of the RestraintEvent resource to be created or updated.", + "required": true, + "x-bodyName": "RestraintEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162437,6 +202818,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResultDatatypeTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -162553,7 +202995,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162596,7 +203038,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162616,27 +203058,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/resultDatatypeTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteResultDatatypeTypesById", + "/ed-fi/resultDatatypeTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResultDatatypeTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -162650,48 +203105,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "resultDatatypeTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/resultDatatypeTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getResultDatatypeTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResultDatatypeTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -162699,14 +203143,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -162718,20 +203162,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "resultDatatypeTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putResultDatatypeType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/resultDatatypeTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteResultDatatypeTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -162746,18 +203194,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ResultDatatypeType resource to be created or updated.", - "required": true, - "x-bodyName": "ResultDatatypeType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -162775,7 +203211,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "resultDatatypeTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getResultDatatypeTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "resultDatatypeTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putResultDatatypeType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ResultDatatypeType resource to be created or updated.", + "required": true, + "x-bodyName": "ResultDatatypeType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163000,6 +203551,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RetestIndicatorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RetestIndicatorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RetestIndicatorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -163116,7 +203728,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163159,7 +203771,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163179,27 +203791,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/retestIndicatorDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRetestIndicatorsById", + "/ed-fi/retestIndicatorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRetestIndicatorsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -163213,48 +203838,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "retestIndicatorDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/retestIndicatorDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRetestIndicatorsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRetestIndicatorsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -163262,14 +203876,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -163281,20 +203895,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "retestIndicatorDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRetestIndicator", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/retestIndicatorDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRetestIndicatorsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -163309,18 +203927,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor" - } - } - }, - "description": "The JSON representation of the RetestIndicator resource to be created or updated.", - "required": true, - "x-bodyName": "RetestIndicator" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -163338,7 +203944,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "retestIndicatorDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRetestIndicatorsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "retestIndicatorDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRetestIndicator", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor" + } + } + }, + "description": "The JSON representation of the RetestIndicator resource to be created or updated.", + "required": true, + "x-bodyName": "RetestIndicator" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163563,6 +204284,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -163679,7 +204461,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163722,7 +204504,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163742,27 +204524,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/schoolCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSchoolCategoriesById", + "/ed-fi/schoolCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -163776,48 +204571,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "schoolCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSchoolCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -163825,14 +204609,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -163844,20 +204628,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "schoolCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSchoolCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSchoolCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -163872,18 +204660,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the SchoolCategory resource to be created or updated.", - "required": true, - "x-bodyName": "SchoolCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -163901,7 +204677,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "schoolCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSchoolCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "schoolCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSchoolCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the SchoolCategory resource to be created or updated.", + "required": true, + "x-bodyName": "SchoolCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164126,6 +205017,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolChoiceBasisDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -164242,7 +205194,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164285,7 +205237,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164305,27 +205257,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/schoolChoiceBasisDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSchoolChoiceBasesById", + "/ed-fi/schoolChoiceBasisDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceBasesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -164339,48 +205304,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "schoolChoiceBasisDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolChoiceBasisDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSchoolChoiceBasesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceBasesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -164388,14 +205342,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -164407,20 +205361,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "schoolChoiceBasisDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSchoolChoiceBasis", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolChoiceBasisDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSchoolChoiceBasesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -164435,18 +205393,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor" - } - } - }, - "description": "The JSON representation of the SchoolChoiceBasis resource to be created or updated.", - "required": true, - "x-bodyName": "SchoolChoiceBasis" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -164464,7 +205410,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "schoolChoiceBasisDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSchoolChoiceBasesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "schoolChoiceBasisDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSchoolChoiceBasis", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor" + } + } + }, + "description": "The JSON representation of the SchoolChoiceBasis resource to be created or updated.", + "required": true, + "x-bodyName": "SchoolChoiceBasis" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164689,6 +205750,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -164805,7 +205927,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164848,7 +205970,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164868,27 +205990,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/schoolChoiceImplementStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSchoolChoiceImplementStatusesById", + "/ed-fi/schoolChoiceImplementStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceImplementStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -164902,48 +206037,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "schoolChoiceImplementStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolChoiceImplementStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSchoolChoiceImplementStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceImplementStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -164951,14 +206075,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -164970,20 +206094,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "schoolChoiceImplementStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSchoolChoiceImplementStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolChoiceImplementStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSchoolChoiceImplementStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -164998,18 +206126,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor" - } - } - }, - "description": "The JSON representation of the SchoolChoiceImplementStatus resource to be created or updated.", - "required": true, - "x-bodyName": "SchoolChoiceImplementStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -165027,7 +206143,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "schoolChoiceImplementStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSchoolChoiceImplementStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "schoolChoiceImplementStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSchoolChoiceImplementStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor" + } + } + }, + "description": "The JSON representation of the SchoolChoiceImplementStatus resource to be created or updated.", + "required": true, + "x-bodyName": "SchoolChoiceImplementStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165252,6 +206483,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -165368,7 +206660,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165411,7 +206703,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165431,27 +206723,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/schoolFoodServiceProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSchoolFoodServiceProgramServicesById", + "/ed-fi/schoolFoodServiceProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolFoodServiceProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -165465,48 +206770,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "schoolFoodServiceProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolFoodServiceProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSchoolFoodServiceProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolFoodServiceProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -165514,14 +206808,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -165533,20 +206827,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "schoolFoodServiceProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSchoolFoodServiceProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolFoodServiceProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSchoolFoodServiceProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -165561,18 +206859,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the SchoolFoodServiceProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "SchoolFoodServiceProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -165590,7 +206876,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "schoolFoodServiceProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSchoolFoodServiceProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "schoolFoodServiceProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSchoolFoodServiceProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the SchoolFoodServiceProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "SchoolFoodServiceProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165815,6 +207216,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -165931,7 +207393,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165974,7 +207436,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165994,27 +207456,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/schoolTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSchoolTypesById", + "/ed-fi/schoolTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -166028,48 +207503,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "schoolTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSchoolTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -166077,14 +207541,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -166096,20 +207560,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "schoolTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSchoolType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSchoolTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -166124,18 +207592,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor" - } - } - }, - "description": "The JSON representation of the SchoolType resource to be created or updated.", - "required": true, - "x-bodyName": "SchoolType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -166153,7 +207609,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "schoolTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSchoolTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "schoolTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSchoolType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor" + } + } + }, + "description": "The JSON representation of the SchoolType resource to be created or updated.", + "required": true, + "x-bodyName": "SchoolType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166347,6 +207918,62 @@ "schoolYear" ], "type": "object" + }, + "EdFi_SchoolYear_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolYear_TrackedChangeKey": { + "properties": { + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "schoolYear" + ], + "type": "object" + }, + "EdFi_SchoolYear_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -166432,7 +208059,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166475,7 +208102,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166495,6 +208122,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/schoolYearTypes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolYearsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolYearTypes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolYearTypes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolYearsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolYearTypes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/schoolYearTypes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -166530,7 +208275,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166562,15 +208307,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -166597,7 +208333,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166654,7 +208390,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -168239,6 +209975,62 @@ "schoolCategoryDescriptor" ], "type": "object" + }, + "EdFi_School_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_School_TrackedChangeKey": { + "properties": { + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "schoolId" + ], + "type": "object" + }, + "EdFi_School_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -168428,7 +210220,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -168471,7 +210263,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -168505,6 +210297,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/schools/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schools" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/schools/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schools" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/schools/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -168540,7 +210478,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -168572,15 +210510,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -168607,7 +210536,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -168664,7 +210593,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169172,6 +211101,92 @@ "sectionIdentifier" ], "type": "object" + }, + "EdFi_SectionAttendanceTakenEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SectionAttendanceTakenEvent_TrackedChangeKey": { + "properties": { + "calendarCode": { + "maxLength": 60, + "type": "string" + }, + "date": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "calendarCode", + "date", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName" + ], + "type": "object" + }, + "EdFi_SectionAttendanceTakenEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -169321,7 +211336,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169364,7 +211379,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169385,27 +211400,40 @@ "StudentAttendance" ] }, - "/ed-fi/sectionAttendanceTakenEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSectionAttendanceTakenEventsById", + "/ed-fi/sectionAttendanceTakenEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionAttendanceTakenEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -169419,48 +211447,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sectionAttendanceTakenEvents" ] }, + "x-Ed-Fi-domains": [ + "StudentAttendance" + ] + }, + "/ed-fi/sectionAttendanceTakenEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSectionAttendanceTakenEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionAttendanceTakenEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -169468,14 +211486,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent" + "items": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -169487,20 +211505,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sectionAttendanceTakenEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSectionAttendanceTakenEvent", + "x-Ed-Fi-domains": [ + "StudentAttendance" + ] + }, + "/ed-fi/sectionAttendanceTakenEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSectionAttendanceTakenEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -169515,18 +211538,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent" - } - } - }, - "description": "The JSON representation of the SectionAttendanceTakenEvent resource to be created or updated.", - "required": true, - "x-bodyName": "SectionAttendanceTakenEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -169544,7 +211555,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sectionAttendanceTakenEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSectionAttendanceTakenEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sectionAttendanceTakenEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSectionAttendanceTakenEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent" + } + } + }, + "description": "The JSON representation of the SectionAttendanceTakenEvent resource to be created or updated.", + "required": true, + "x-bodyName": "SectionAttendanceTakenEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169795,6 +211921,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SectionCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SectionCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SectionCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -169911,7 +212098,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169954,7 +212141,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169974,27 +212161,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/sectionCharacteristicDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSectionCharacteristicsById", + "/ed-fi/sectionCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionCharacteristicsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -170008,48 +212208,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sectionCharacteristicDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sectionCharacteristicDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSectionCharacteristicsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionCharacteristicsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -170057,14 +212246,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -170076,20 +212265,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sectionCharacteristicDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSectionCharacteristic", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sectionCharacteristicDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSectionCharacteristicsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -170104,18 +212297,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor" - } - } - }, - "description": "The JSON representation of the SectionCharacteristic resource to be created or updated.", - "required": true, - "x-bodyName": "SectionCharacteristic" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -170133,7 +212314,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sectionCharacteristicDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSectionCharacteristicsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sectionCharacteristicDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSectionCharacteristic", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor" + } + } + }, + "description": "The JSON representation of the SectionCharacteristic resource to be created or updated.", + "required": true, + "x-bodyName": "SectionCharacteristic" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -170358,6 +212654,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SectionTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SectionTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SectionTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -170474,7 +212831,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170517,7 +212874,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -170537,27 +212894,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/sectionTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSectionTypesById", + "/ed-fi/sectionTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -170571,48 +212941,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sectionTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sectionTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSectionTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -170620,14 +212979,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -170639,20 +212998,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sectionTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSectionType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sectionTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSectionTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -170667,18 +213030,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor" - } - } - }, - "description": "The JSON representation of the SectionType resource to be created or updated.", - "required": true, - "x-bodyName": "SectionType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -170696,7 +213047,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sectionTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSectionTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sectionTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSectionType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor" + } + } + }, + "description": "The JSON representation of the SectionType resource to be created or updated.", + "required": true, + "x-bodyName": "SectionType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -171641,6 +214107,82 @@ "sectionCharacteristicDescriptor" ], "type": "object" + }, + "EdFi_Section_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Section_TrackedChangeKey": { + "properties": { + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName" + ], + "type": "object" + }, + "EdFi_Section_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -171869,7 +214411,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -171912,7 +214454,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -171944,27 +214486,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/sections/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSectionsById", + "/ed-fi/sections/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -171978,48 +214533,49 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sections" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sections/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSectionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -172027,14 +214583,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Section" + "items": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -172046,20 +214602,36 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sections" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSection", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sections/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSectionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -172074,18 +214646,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Section" - } - } - }, - "description": "The JSON representation of the Section resource to be created or updated.", - "required": true, - "x-bodyName": "Section" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -172103,7 +214663,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sections" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSectionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Section" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sections" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSection", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Section" + } + } + }, + "description": "The JSON representation of the Section resource to be created or updated.", + "required": true, + "x-bodyName": "Section" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172423,6 +215098,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SeparationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SeparationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SeparationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -172539,7 +215275,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172582,7 +215318,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172602,27 +215338,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/separationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSeparationsById", + "/ed-fi/separationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -172636,48 +215385,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "separationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/separationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSeparationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -172685,14 +215423,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SeparationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -172704,20 +215442,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "separationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSeparation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/separationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSeparationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -172732,18 +215474,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SeparationDescriptor" - } - } - }, - "description": "The JSON representation of the Separation resource to be created or updated.", - "required": true, - "x-bodyName": "Separation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -172761,7 +215491,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "separationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSeparationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "separationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSeparation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor" + } + } + }, + "description": "The JSON representation of the Separation resource to be created or updated.", + "required": true, + "x-bodyName": "Separation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172986,6 +215831,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SeparationReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SeparationReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SeparationReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -173102,7 +216008,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173145,7 +216051,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173165,27 +216071,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/separationReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSeparationReasonsById", + "/ed-fi/separationReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -173199,48 +216118,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "separationReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/separationReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSeparationReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -173248,14 +216156,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -173267,20 +216175,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "separationReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSeparationReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/separationReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSeparationReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -173295,18 +216207,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor" - } - } - }, - "description": "The JSON representation of the SeparationReason resource to be created or updated.", - "required": true, - "x-bodyName": "SeparationReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -173324,7 +216224,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "separationReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSeparationReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "separationReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSeparationReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor" + } + } + }, + "description": "The JSON representation of the SeparationReason resource to be created or updated.", + "required": true, + "x-bodyName": "SeparationReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173549,6 +216564,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -173665,7 +216741,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173708,7 +216784,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173728,27 +216804,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/serviceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteServicesById", + "/ed-fi/serviceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -173762,48 +216851,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "serviceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/serviceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -173811,14 +216889,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -173830,20 +216908,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "serviceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/serviceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -173858,18 +216940,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ServiceDescriptor" - } - } - }, - "description": "The JSON representation of the Service resource to be created or updated.", - "required": true, - "x-bodyName": "Service" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -173887,7 +216957,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "serviceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "serviceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor" + } + } + }, + "description": "The JSON representation of the Service resource to be created or updated.", + "required": true, + "x-bodyName": "Service" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -174434,6 +217619,72 @@ "sessionName" ], "type": "object" + }, + "EdFi_Session_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Session_TrackedChangeKey": { + "properties": { + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ], + "type": "object" + }, + "EdFi_Session_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -174560,7 +217811,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -174603,7 +217854,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -174630,27 +217881,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/sessions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSessionsById", + "/ed-fi/sessions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSessionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -174664,48 +217928,44 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sessions" ] }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "SchoolCalendar", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sessions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSessionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSessionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -174713,14 +217973,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Session" + "items": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -174732,20 +217992,31 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sessions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSession", + "x-Ed-Fi-domains": [ + "BellSchedule", + "SchoolCalendar", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sessions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSessionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -174760,18 +218031,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Session" - } - } - }, - "description": "The JSON representation of the Session resource to be created or updated.", - "required": true, - "x-bodyName": "Session" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -174789,7 +218048,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sessions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSessionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Session" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sessions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSession", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Session" + } + } + }, + "description": "The JSON representation of the Session resource to be created or updated.", + "required": true, + "x-bodyName": "Session" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -175031,6 +218405,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SexDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SexDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SexDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -175147,7 +218582,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175190,7 +218625,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -175210,27 +218645,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/sexDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSexesById", + "/ed-fi/sexDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSexesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -175244,48 +218692,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sexDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sexDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSexesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSexesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -175293,14 +218730,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SexDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -175312,20 +218749,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sexDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSex", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sexDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSexesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -175340,18 +218781,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SexDescriptor" - } - } - }, - "description": "The JSON representation of the Sex resource to be created or updated.", - "required": true, - "x-bodyName": "Sex" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -175369,7 +218798,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sexDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSexesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SexDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sexDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSex", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SexDescriptor" + } + } + }, + "description": "The JSON representation of the Sex resource to be created or updated.", + "required": true, + "x-bodyName": "Sex" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -175656,6 +219200,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_SourceDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SourceDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_SourceDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -175745,7 +219350,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175788,7 +219393,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -175809,27 +219414,40 @@ "Finance" ] }, - "/ed-fi/sourceDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSourceDimensionsById", + "/ed-fi/sourceDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSourceDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -175843,48 +219461,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sourceDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/sourceDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSourceDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSourceDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -175892,14 +219500,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SourceDimension" + "items": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -175911,20 +219519,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sourceDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSourceDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/sourceDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSourceDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -175939,18 +219552,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SourceDimension" - } - } - }, - "description": "The JSON representation of the SourceDimension resource to be created or updated.", - "required": true, - "x-bodyName": "SourceDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -175968,7 +219569,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sourceDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSourceDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SourceDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sourceDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSourceDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SourceDimension" + } + } + }, + "description": "The JSON representation of the SourceDimension resource to be created or updated.", + "required": true, + "x-bodyName": "SourceDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176175,6 +219891,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SourceSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SourceSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SourceSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -176291,7 +220068,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176334,7 +220111,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176354,27 +220131,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/sourceSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSourceSystemsById", + "/ed-fi/sourceSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSourceSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -176388,48 +220178,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sourceSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sourceSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSourceSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSourceSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -176437,14 +220216,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -176456,20 +220235,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sourceSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSourceSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sourceSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSourceSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -176484,18 +220267,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor" - } - } - }, - "description": "The JSON representation of the SourceSystem resource to be created or updated.", - "required": true, - "x-bodyName": "SourceSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -176513,7 +220284,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sourceSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSourceSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sourceSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSourceSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor" + } + } + }, + "description": "The JSON representation of the SourceSystem resource to be created or updated.", + "required": true, + "x-bodyName": "SourceSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176738,6 +220624,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -176854,7 +220801,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176897,7 +220844,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176917,27 +220864,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/specialEducationExitReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSpecialEducationExitReasonsById", + "/ed-fi/specialEducationExitReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationExitReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -176951,48 +220911,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "specialEducationExitReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationExitReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSpecialEducationExitReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationExitReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -177000,14 +220949,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -177019,20 +220968,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "specialEducationExitReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSpecialEducationExitReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationExitReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSpecialEducationExitReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -177047,18 +221000,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor" - } - } - }, - "description": "The JSON representation of the SpecialEducationExitReason resource to be created or updated.", - "required": true, - "x-bodyName": "SpecialEducationExitReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -177076,7 +221017,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "specialEducationExitReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSpecialEducationExitReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "specialEducationExitReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSpecialEducationExitReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor" + } + } + }, + "description": "The JSON representation of the SpecialEducationExitReason resource to be created or updated.", + "required": true, + "x-bodyName": "SpecialEducationExitReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177301,6 +221357,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -177417,7 +221534,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177460,7 +221577,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177480,27 +221597,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/specialEducationProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSpecialEducationProgramServicesById", + "/ed-fi/specialEducationProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -177514,48 +221644,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "specialEducationProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSpecialEducationProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -177563,14 +221682,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -177582,20 +221701,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "specialEducationProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSpecialEducationProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSpecialEducationProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -177610,18 +221733,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the SpecialEducationProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "SpecialEducationProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -177639,7 +221750,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "specialEducationProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSpecialEducationProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "specialEducationProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSpecialEducationProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the SpecialEducationProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "SpecialEducationProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177864,6 +222090,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SpecialEducationSettingDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SpecialEducationSettingDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -177980,7 +222267,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178023,7 +222310,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178043,27 +222330,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/specialEducationSettingDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSpecialEducationSettingsById", + "/ed-fi/specialEducationSettingDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationSettingsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -178077,48 +222377,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "specialEducationSettingDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationSettingDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSpecialEducationSettingsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationSettingsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -178126,14 +222415,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -178145,20 +222434,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "specialEducationSettingDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSpecialEducationSetting", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationSettingDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSpecialEducationSettingsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -178173,18 +222466,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor" - } - } - }, - "description": "The JSON representation of the SpecialEducationSetting resource to be created or updated.", - "required": true, - "x-bodyName": "SpecialEducationSetting" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -178202,7 +222483,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "specialEducationSettingDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSpecialEducationSettingsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "specialEducationSettingDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSpecialEducationSetting", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor" + } + } + }, + "description": "The JSON representation of the SpecialEducationSetting resource to be created or updated.", + "required": true, + "x-bodyName": "SpecialEducationSetting" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178497,6 +222893,72 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffAbsenceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffAbsenceEvent_TrackedChangeKey": { + "properties": { + "absenceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "absenceEventCategoryDescriptor", + "eventDate", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffAbsenceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -178605,7 +223067,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178648,7 +223110,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178669,27 +223131,40 @@ "Staff" ] }, - "/ed-fi/staffAbsenceEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffAbsenceEventsById", + "/ed-fi/staffAbsenceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffAbsenceEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -178703,48 +223178,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffAbsenceEvents" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffAbsenceEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffAbsenceEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffAbsenceEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -178752,14 +223217,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent" + "items": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -178771,20 +223236,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffAbsenceEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffAbsenceEvent", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffAbsenceEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffAbsenceEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -178799,18 +223269,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent" - } - } - }, - "description": "The JSON representation of the StaffAbsenceEvent resource to be created or updated.", - "required": true, - "x-bodyName": "StaffAbsenceEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -178828,7 +223286,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffAbsenceEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffAbsenceEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffAbsenceEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffAbsenceEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent" + } + } + }, + "description": "The JSON representation of the StaffAbsenceEvent resource to be created or updated.", + "required": true, + "x-bodyName": "StaffAbsenceEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179048,6 +223621,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffClassificationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffClassificationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffClassificationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -179164,7 +223798,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179207,7 +223841,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179227,27 +223861,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/staffClassificationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffClassificationsById", + "/ed-fi/staffClassificationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffClassificationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -179261,48 +223908,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffClassificationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffClassificationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffClassificationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffClassificationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -179310,14 +223946,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -179329,20 +223965,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffClassificationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffClassification", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffClassificationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffClassificationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -179357,18 +223997,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor" - } - } - }, - "description": "The JSON representation of the StaffClassification resource to be created or updated.", - "required": true, - "x-bodyName": "StaffClassification" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -179386,7 +224014,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffClassificationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffClassificationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffClassificationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffClassification", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor" + } + } + }, + "description": "The JSON representation of the StaffClassification resource to be created or updated.", + "required": true, + "x-bodyName": "StaffClassification" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179709,6 +224452,77 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffCohortAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffCohortAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "cohortIdentifier": { + "maxLength": 36, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "cohortIdentifier", + "educationOrganizationId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffCohortAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -179826,7 +224640,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179869,7 +224683,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179890,27 +224704,40 @@ "StudentCohort" ] }, - "/ed-fi/staffCohortAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffCohortAssociationsById", + "/ed-fi/staffCohortAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffCohortAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -179924,48 +224751,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffCohortAssociations" ] }, + "x-Ed-Fi-domains": [ + "StudentCohort" + ] + }, + "/ed-fi/staffCohortAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffCohortAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffCohortAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -179973,14 +224790,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffCohortAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -179992,20 +224809,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffCohortAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffCohortAssociation", + "x-Ed-Fi-domains": [ + "StudentCohort" + ] + }, + "/ed-fi/staffCohortAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffCohortAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -180020,18 +224842,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffCohortAssociation" - } - } - }, - "description": "The JSON representation of the StaffCohortAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffCohortAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -180049,7 +224859,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffCohortAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffCohortAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffCohortAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffCohortAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation" + } + } + }, + "description": "The JSON representation of the StaffCohortAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffCohortAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180368,6 +225293,72 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffDisciplineIncidentAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey": { + "properties": { + "incidentIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "incidentIdentifier", + "schoolId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -180458,7 +225449,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180501,7 +225492,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180521,27 +225512,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/staffDisciplineIncidentAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffDisciplineIncidentAssociationsById", + "/ed-fi/staffDisciplineIncidentAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDisciplineIncidentAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -180555,48 +225559,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffDisciplineIncidentAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffDisciplineIncidentAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffDisciplineIncidentAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDisciplineIncidentAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -180604,14 +225597,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -180623,20 +225616,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffDisciplineIncidentAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffDisciplineIncidentAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffDisciplineIncidentAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffDisciplineIncidentAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -180651,18 +225648,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation" - } - } - }, - "description": "The JSON representation of the StaffDisciplineIncidentAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffDisciplineIncidentAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -180680,7 +225665,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffDisciplineIncidentAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffDisciplineIncidentAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffDisciplineIncidentAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffDisciplineIncidentAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation" + } + } + }, + "description": "The JSON representation of the StaffDisciplineIncidentAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffDisciplineIncidentAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181163,6 +226263,77 @@ "staffClassificationDescriptor" ], "type": "object" + }, + "EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffClassificationDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "staffClassificationDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -181349,7 +226520,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181392,7 +226563,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181414,27 +226585,40 @@ "TeacherPreparation" ] }, - "/ed-fi/staffEducationOrganizationAssignmentAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffEducationOrganizationAssignmentAssociationsById", + "/ed-fi/staffEducationOrganizationAssignmentAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationAssignmentAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -181448,48 +226632,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffEducationOrganizationAssignmentAssociations" ] }, + "x-Ed-Fi-domains": [ + "Staff", + "TeacherPreparation" + ] + }, + "/ed-fi/staffEducationOrganizationAssignmentAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffEducationOrganizationAssignmentAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationAssignmentAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -181497,14 +226672,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -181516,20 +226691,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffEducationOrganizationAssignmentAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffEducationOrganizationAssignmentAssociation", + "x-Ed-Fi-domains": [ + "Staff", + "TeacherPreparation" + ] + }, + "/ed-fi/staffEducationOrganizationAssignmentAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffEducationOrganizationAssignmentAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -181544,18 +226725,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation" - } - } - }, - "description": "The JSON representation of the StaffEducationOrganizationAssignmentAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffEducationOrganizationAssignmentAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -181573,7 +226742,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffEducationOrganizationAssignmentAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffEducationOrganizationAssignmentAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffEducationOrganizationAssignmentAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffEducationOrganizationAssignmentAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation" + } + } + }, + "description": "The JSON representation of the StaffEducationOrganizationAssignmentAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffEducationOrganizationAssignmentAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -182430,6 +227714,72 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKey": { + "properties": { + "contactTitle": { + "maxLength": 75, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "contactTitle", + "educationOrganizationId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -182539,7 +227889,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182582,7 +227932,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -182603,27 +227953,40 @@ "Staff" ] }, - "/ed-fi/staffEducationOrganizationContactAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffEducationOrganizationContactAssociationsById", + "/ed-fi/staffEducationOrganizationContactAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationContactAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -182637,48 +228000,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffEducationOrganizationContactAssociations" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationContactAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffEducationOrganizationContactAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationContactAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -182686,14 +228039,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -182705,20 +228058,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffEducationOrganizationContactAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffEducationOrganizationContactAssociation", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationContactAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffEducationOrganizationContactAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -182733,18 +228091,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation" - } - } - }, - "description": "The JSON representation of the StaffEducationOrganizationContactAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffEducationOrganizationContactAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -182762,7 +228108,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffEducationOrganizationContactAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffEducationOrganizationContactAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffEducationOrganizationContactAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffEducationOrganizationContactAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation" + } + } + }, + "description": "The JSON representation of the StaffEducationOrganizationContactAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffEducationOrganizationContactAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183272,6 +228733,77 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "employmentStatusDescriptor": { + "maxLength": 306, + "type": "string" + }, + "hireDate": { + "format": "date", + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "employmentStatusDescriptor", + "hireDate", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -183464,7 +228996,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183507,7 +229039,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183528,27 +229060,40 @@ "Staff" ] }, - "/ed-fi/staffEducationOrganizationEmploymentAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffEducationOrganizationEmploymentAssociationsById", + "/ed-fi/staffEducationOrganizationEmploymentAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationEmploymentAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -183562,48 +229107,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffEducationOrganizationEmploymentAssociations" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationEmploymentAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffEducationOrganizationEmploymentAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationEmploymentAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -183611,14 +229146,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -183630,20 +229165,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffEducationOrganizationEmploymentAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffEducationOrganizationEmploymentAssociation", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationEmploymentAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffEducationOrganizationEmploymentAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -183658,18 +229198,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation" - } - } - }, - "description": "The JSON representation of the StaffEducationOrganizationEmploymentAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffEducationOrganizationEmploymentAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -183687,7 +229215,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffEducationOrganizationEmploymentAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffEducationOrganizationEmploymentAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffEducationOrganizationEmploymentAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffEducationOrganizationEmploymentAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation" + } + } + }, + "description": "The JSON representation of the StaffEducationOrganizationEmploymentAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffEducationOrganizationEmploymentAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183965,6 +229608,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -184081,7 +229785,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184124,7 +229828,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -184144,27 +229848,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/staffIdentificationSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffIdentificationSystemsById", + "/ed-fi/staffIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffIdentificationSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -184178,48 +229895,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffIdentificationSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffIdentificationSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffIdentificationSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffIdentificationSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -184227,14 +229933,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -184246,20 +229952,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffIdentificationSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffIdentificationSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffIdentificationSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffIdentificationSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -184274,18 +229984,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor" - } - } - }, - "description": "The JSON representation of the StaffIdentificationSystem resource to be created or updated.", - "required": true, - "x-bodyName": "StaffIdentificationSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -184303,7 +230001,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffIdentificationSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffIdentificationSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffIdentificationSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffIdentificationSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor" + } + } + }, + "description": "The JSON representation of the StaffIdentificationSystem resource to be created or updated.", + "required": true, + "x-bodyName": "StaffIdentificationSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -184528,6 +230341,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -184644,7 +230518,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184687,7 +230561,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -184707,27 +230581,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/staffLeaveEventCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffLeaveEventCategoriesById", + "/ed-fi/staffLeaveEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeaveEventCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -184741,48 +230628,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffLeaveEventCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffLeaveEventCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffLeaveEventCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeaveEventCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -184790,14 +230666,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -184809,20 +230685,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffLeaveEventCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffLeaveEventCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffLeaveEventCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffLeaveEventCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -184837,18 +230717,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the StaffLeaveEventCategory resource to be created or updated.", - "required": true, - "x-bodyName": "StaffLeaveEventCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -184866,7 +230734,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffLeaveEventCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffLeaveEventCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffLeaveEventCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffLeaveEventCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the StaffLeaveEventCategory resource to be created or updated.", + "required": true, + "x-bodyName": "StaffLeaveEventCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -185174,6 +231157,72 @@ "staffLeaveEventCategoryDescriptor" ], "type": "object" + }, + "EdFi_StaffLeave_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffLeave_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "staffLeaveEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "staffLeaveEventCategoryDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffLeave_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -185290,7 +231339,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -185333,7 +231382,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -185354,27 +231403,40 @@ "Staff" ] }, - "/ed-fi/staffLeaves/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffLeavesById", + "/ed-fi/staffLeaves/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeavesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -185388,48 +231450,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffLeaves" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffLeaves/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffLeavesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeavesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -185437,14 +231489,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffLeave" + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -185456,20 +231508,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffLeaves" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffLeave", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffLeaves/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffLeavesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -185484,18 +231541,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffLeave" - } - } - }, - "description": "The JSON representation of the StaffLeave resource to be created or updated.", - "required": true, - "x-bodyName": "StaffLeave" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -185513,7 +231558,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffLeaves" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffLeavesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffLeave" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffLeaves" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffLeave", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffLeave" + } + } + }, + "description": "The JSON representation of the StaffLeave resource to be created or updated.", + "required": true, + "x-bodyName": "StaffLeave" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -185859,6 +232019,82 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -185986,7 +232222,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -186029,7 +232265,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -186053,27 +232289,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/staffProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffProgramAssociationsById", + "/ed-fi/staffProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -186087,48 +232336,41 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -186136,14 +232378,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -186155,20 +232397,28 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffProgramAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -186183,18 +232433,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffProgramAssociation" - } - } - }, - "description": "The JSON representation of the StaffProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -186212,7 +232450,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation" + } + } + }, + "description": "The JSON representation of the StaffProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -186710,6 +233063,72 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffSchoolAssociation_TrackedChangeKey": { + "properties": { + "programAssignmentDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "programAssignmentDescriptor", + "schoolId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -186819,7 +233238,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -186862,7 +233281,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -186885,27 +233304,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/staffSchoolAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffSchoolAssociationsById", + "/ed-fi/staffSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSchoolAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -186919,48 +233351,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffSchoolAssociations" ] }, + "x-Ed-Fi-domains": [ + "Staff", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffSchoolAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffSchoolAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSchoolAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -186968,14 +233392,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -186987,20 +233411,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffSchoolAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffSchoolAssociation", + "x-Ed-Fi-domains": [ + "Staff", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffSchoolAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffSchoolAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -187015,18 +233446,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation" - } - } - }, - "description": "The JSON representation of the StaffSchoolAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffSchoolAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -187044,7 +233463,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffSchoolAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffSchoolAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffSchoolAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffSchoolAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation" + } + } + }, + "description": "The JSON representation of the StaffSchoolAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffSchoolAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -187496,6 +234030,92 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffSectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffSectionAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffSectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -187669,7 +234289,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -187712,7 +234332,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -187736,27 +234356,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/staffSectionAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffSectionAssociationsById", + "/ed-fi/staffSectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSectionAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -187770,48 +234403,41 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffSectionAssociations" ] }, + "x-Ed-Fi-domains": [ + "SpecialEducation", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffSectionAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffSectionAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSectionAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -187819,14 +234445,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffSectionAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -187838,20 +234464,28 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffSectionAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffSectionAssociation", + "x-Ed-Fi-domains": [ + "SpecialEducation", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffSectionAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffSectionAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -187866,18 +234500,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffSectionAssociation" - } - } - }, - "description": "The JSON representation of the StaffSectionAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffSectionAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -187895,7 +234517,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffSectionAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffSectionAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffSectionAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffSectionAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation" + } + } + }, + "description": "The JSON representation of the StaffSectionAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffSectionAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -190622,6 +237359,62 @@ ], "type": "object" }, + "EdFi_Staff_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Staff_TrackedChangeKey": { + "properties": { + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_Staff_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_Staff_TribalAffiliation": { "properties": { "tribalAffiliationDescriptor": { @@ -190884,7 +237677,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190927,7 +237720,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -190957,27 +237750,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/staffs/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffsById", + "/ed-fi/staffs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -190991,48 +237797,47 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffs" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffs/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -191040,14 +237845,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Staff" + "items": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -191059,20 +237864,34 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffs" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaff", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffs/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -191087,18 +237906,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Staff" - } - } - }, - "description": "The JSON representation of the Staff resource to be created or updated.", - "required": true, - "x-bodyName": "Staff" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -191116,7 +237923,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffs" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Staff" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffs" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaff", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Staff" + } + } + }, + "description": "The JSON representation of the Staff resource to be created or updated.", + "required": true, + "x-bodyName": "Staff" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191450,6 +238372,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StateAbbreviationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StateAbbreviationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StateAbbreviationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -191566,7 +238549,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191609,7 +238592,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191629,27 +238612,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/stateAbbreviationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStateAbbreviationsById", + "/ed-fi/stateAbbreviationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStateAbbreviationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -191663,48 +238659,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "stateAbbreviationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/stateAbbreviationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStateAbbreviationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStateAbbreviationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -191712,14 +238697,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -191731,20 +238716,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "stateAbbreviationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStateAbbreviation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/stateAbbreviationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStateAbbreviationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -191759,18 +238748,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor" - } - } - }, - "description": "The JSON representation of the StateAbbreviation resource to be created or updated.", - "required": true, - "x-bodyName": "StateAbbreviation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -191788,7 +238765,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "stateAbbreviationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStateAbbreviationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "stateAbbreviationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStateAbbreviation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor" + } + } + }, + "description": "The JSON representation of the StateAbbreviation resource to be created or updated.", + "required": true, + "x-bodyName": "StateAbbreviation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -193214,6 +240306,62 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_StateEducationAgency_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StateEducationAgency_TrackedChangeKey": { + "properties": { + "stateEducationAgencyId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "stateEducationAgencyId" + ], + "type": "object" + }, + "EdFi_StateEducationAgency_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -193321,7 +240469,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -193364,7 +240512,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -193386,27 +240534,40 @@ "Staff" ] }, - "/ed-fi/stateEducationAgencies/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStateEducationAgenciesById", + "/ed-fi/stateEducationAgencies/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStateEducationAgenciesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -193420,48 +240581,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "stateEducationAgencies" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, + "/ed-fi/stateEducationAgencies/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStateEducationAgenciesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStateEducationAgenciesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -193469,14 +240621,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StateEducationAgency" + "items": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -193488,20 +240640,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "stateEducationAgencies" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStateEducationAgency", + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, + "/ed-fi/stateEducationAgencies/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStateEducationAgenciesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -193516,18 +240674,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StateEducationAgency" - } - } - }, - "description": "The JSON representation of the StateEducationAgency resource to be created or updated.", - "required": true, - "x-bodyName": "StateEducationAgency" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -193545,7 +240691,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "stateEducationAgencies" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStateEducationAgenciesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "stateEducationAgencies" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStateEducationAgency", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency" + } + } + }, + "description": "The JSON representation of the StateEducationAgency resource to be created or updated.", + "required": true, + "x-bodyName": "StateEducationAgency" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -195394,6 +242655,77 @@ "reportCardReference" ], "type": "object" + }, + "EdFi_StudentAcademicRecord_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAcademicRecord_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "schoolYear", + "studentUniqueId", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_StudentAcademicRecord_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -195611,7 +242943,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -195654,7 +242986,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -195677,27 +243009,40 @@ "StudentTranscript" ] }, - "/ed-fi/studentAcademicRecords/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentAcademicRecordsById", + "/ed-fi/studentAcademicRecords/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAcademicRecordsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -195711,48 +243056,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentAcademicRecords" ] }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "StudentTranscript" + ] + }, + "/ed-fi/studentAcademicRecords/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentAcademicRecordsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAcademicRecordsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -195760,14 +243097,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentAcademicRecord" + "items": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -195779,20 +243116,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentAcademicRecords" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentAcademicRecord", + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "StudentTranscript" + ] + }, + "/ed-fi/studentAcademicRecords/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentAcademicRecordsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -195807,18 +243151,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentAcademicRecord" - } - } - }, - "description": "The JSON representation of the StudentAcademicRecord resource to be created or updated.", - "required": true, - "x-bodyName": "StudentAcademicRecord" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -195836,7 +243168,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentAcademicRecords" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentAcademicRecordsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentAcademicRecords" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentAcademicRecord", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord" + } + } + }, + "description": "The JSON representation of the StudentAcademicRecord resource to be created or updated.", + "required": true, + "x-bodyName": "StudentAcademicRecord" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -196274,6 +243721,88 @@ "studentAssessmentIdentifier" ], "type": "object" + }, + "EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "educationOrganizationAssociationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentAssessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "educationOrganizationAssociationTypeDescriptor", + "educationOrganizationId", + "namespace", + "studentAssessmentIdentifier", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -196404,7 +243933,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -196447,7 +243976,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -196467,27 +243996,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentAssessmentEducationOrganizationAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentAssessmentEducationOrganizationAssociationsById", + "/ed-fi/studentAssessmentEducationOrganizationAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentEducationOrganizationAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -196501,48 +244043,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentAssessmentEducationOrganizationAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentAssessmentEducationOrganizationAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentAssessmentEducationOrganizationAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentEducationOrganizationAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -196550,14 +244081,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -196569,20 +244100,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentAssessmentEducationOrganizationAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentAssessmentEducationOrganizationAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentAssessmentEducationOrganizationAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentAssessmentEducationOrganizationAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -196597,18 +244132,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation" - } - } - }, - "description": "The JSON representation of the StudentAssessmentEducationOrganizationAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentAssessmentEducationOrganizationAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -196626,7 +244149,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentAssessmentEducationOrganizationAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentAssessmentEducationOrganizationAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentAssessmentEducationOrganizationAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentAssessmentEducationOrganizationAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation" + } + } + }, + "description": "The JSON representation of the StudentAssessmentEducationOrganizationAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentAssessmentEducationOrganizationAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198130,6 +245768,78 @@ "objectiveAssessmentReference" ], "type": "object" + }, + "EdFi_StudentAssessment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAssessment_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentAssessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "namespace", + "studentAssessmentIdentifier", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentAssessment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -198367,7 +246077,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198410,7 +246120,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198432,27 +246142,40 @@ "StudentAssessment" ] }, - "/ed-fi/studentAssessments/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentAssessmentsById", + "/ed-fi/studentAssessments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -198466,48 +246189,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentAssessments" ] }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/studentAssessments/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentAssessmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -198515,14 +246229,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentAssessment" + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -198534,20 +246248,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentAssessments" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentAssessment", + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/studentAssessments/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentAssessmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -198562,18 +246282,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentAssessment" - } - } - }, - "description": "The JSON representation of the StudentAssessment resource to be created or updated.", - "required": true, - "x-bodyName": "StudentAssessment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -198591,7 +246299,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentAssessments" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentAssessmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAssessment" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentAssessments" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentAssessment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAssessment" + } + } + }, + "description": "The JSON representation of the StudentAssessment resource to be created or updated.", + "required": true, + "x-bodyName": "StudentAssessment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -199386,6 +247209,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentCteProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCteProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentCteProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -199557,7 +247461,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199600,7 +247504,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -199620,27 +247524,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentCTEProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentCTEProgramAssociationsById", + "/ed-fi/studentCTEProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCTEProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -199654,48 +247571,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentCTEProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentCTEProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentCTEProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCTEProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -199703,14 +247609,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -199722,20 +247628,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentCTEProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentCTEProgramAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentCTEProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentCTEProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -199750,18 +247660,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentCTEProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentCTEProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -199779,7 +247677,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentCTEProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentCTEProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentCTEProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentCTEProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentCTEProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentCTEProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200052,6 +248065,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StudentCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StudentCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -200168,7 +248242,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200211,7 +248285,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200231,27 +248305,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentCharacteristicDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentCharacteristicsById", + "/ed-fi/studentCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCharacteristicsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -200265,48 +248352,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentCharacteristicDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentCharacteristicDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentCharacteristicsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCharacteristicsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -200314,14 +248390,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -200333,20 +248409,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentCharacteristicDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentCharacteristic", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentCharacteristicDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentCharacteristicsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -200361,18 +248441,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor" - } - } - }, - "description": "The JSON representation of the StudentCharacteristic resource to be created or updated.", - "required": true, - "x-bodyName": "StudentCharacteristic" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -200390,7 +248458,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentCharacteristicDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentCharacteristicsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentCharacteristicDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentCharacteristic", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor" + } + } + }, + "description": "The JSON representation of the StudentCharacteristic resource to be created or updated.", + "required": true, + "x-bodyName": "StudentCharacteristic" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200809,6 +248992,77 @@ "sectionReference" ], "type": "object" + }, + "EdFi_StudentCohortAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCohortAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "cohortIdentifier": { + "maxLength": 36, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "cohortIdentifier", + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentCohortAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -200918,7 +249172,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200961,7 +249215,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200983,27 +249237,40 @@ "StudentCohort" ] }, - "/ed-fi/studentCohortAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentCohortAssociationsById", + "/ed-fi/studentCohortAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCohortAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -201017,48 +249284,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentCohortAssociations" ] }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/studentCohortAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentCohortAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCohortAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -201066,14 +249324,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentCohortAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -201085,20 +249343,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentCohortAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentCohortAssociation", + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/studentCohortAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentCohortAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -201113,18 +249377,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentCohortAssociation" - } - } - }, - "description": "The JSON representation of the StudentCohortAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentCohortAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -201142,7 +249394,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentCohortAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentCohortAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentCohortAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentCohortAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation" + } + } + }, + "description": "The JSON representation of the StudentCohortAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentCohortAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -201815,6 +250182,97 @@ "studentSectionAssociationReference" ], "type": "object" + }, + "EdFi_StudentCompetencyObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCompetencyObjective_TrackedChangeKey": { + "properties": { + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "type": "string" + }, + "gradingPeriodSchoolId": { + "format": "int64", + "type": "integer" + }, + "gradingPeriodSchoolYear": { + "format": "int32", + "type": "integer" + }, + "objective": { + "maxLength": 60, + "type": "string" + }, + "objectiveEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "objectiveGradeLevelDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolId", + "gradingPeriodSchoolYear", + "objective", + "objectiveEducationOrganizationId", + "objectiveGradeLevelDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentCompetencyObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -201973,7 +250431,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -202016,7 +250474,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -202038,27 +250496,40 @@ "ReportCard" ] }, - "/ed-fi/studentCompetencyObjectives/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentCompetencyObjectivesById", + "/ed-fi/studentCompetencyObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCompetencyObjectivesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -202072,48 +250543,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentCompetencyObjectives" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/studentCompetencyObjectives/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentCompetencyObjectivesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCompetencyObjectivesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -202121,14 +250583,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective" + "items": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -202140,20 +250602,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentCompetencyObjectives" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentCompetencyObjective", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/studentCompetencyObjectives/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentCompetencyObjectivesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -202168,18 +250636,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective" - } - } - }, - "description": "The JSON representation of the StudentCompetencyObjective resource to be created or updated.", - "required": true, - "x-bodyName": "StudentCompetencyObjective" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -202197,7 +250653,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentCompetencyObjectives" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentCompetencyObjectivesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentCompetencyObjectives" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentCompetencyObjective", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective" + } + } + }, + "description": "The JSON representation of the StudentCompetencyObjective resource to be created or updated.", + "required": true, + "x-bodyName": "StudentCompetencyObjective" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -202594,6 +251165,67 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentContactAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentContactAssociation_TrackedChangeKey": { + "properties": { + "contactUniqueId": { + "maxLength": 32, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "contactUniqueId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentContactAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -202733,7 +251365,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -202776,7 +251408,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -202797,27 +251429,40 @@ "StudentIdentificationAndDemographics" ] }, - "/ed-fi/studentContactAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentContactAssociationsById", + "/ed-fi/studentContactAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentContactAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -202831,48 +251476,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentContactAssociations" ] }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentContactAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentContactAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentContactAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -202880,14 +251515,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentContactAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -202899,20 +251534,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentContactAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentContactAssociation", + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentContactAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentContactAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -202927,18 +251567,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentContactAssociation" - } - } - }, - "description": "The JSON representation of the StudentContactAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentContactAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -202956,7 +251584,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentContactAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentContactAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentContactAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentContactAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation" + } + } + }, + "description": "The JSON representation of the StudentContactAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentContactAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -203337,6 +252080,77 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey": { + "properties": { + "behaviorDescriptor": { + "maxLength": 306, + "type": "string" + }, + "incidentIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "behaviorDescriptor", + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -203446,7 +252260,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -203489,7 +252303,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -203509,27 +252323,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentDisciplineIncidentBehaviorAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentDisciplineIncidentBehaviorAssociationsById", + "/ed-fi/studentDisciplineIncidentBehaviorAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentBehaviorAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -203543,48 +252370,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentDisciplineIncidentBehaviorAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentDisciplineIncidentBehaviorAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentDisciplineIncidentBehaviorAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentBehaviorAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -203592,14 +252408,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -203611,20 +252427,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentDisciplineIncidentBehaviorAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentDisciplineIncidentBehaviorAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentDisciplineIncidentBehaviorAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentDisciplineIncidentBehaviorAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -203639,18 +252459,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation" - } - } - }, - "description": "The JSON representation of the StudentDisciplineIncidentBehaviorAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentDisciplineIncidentBehaviorAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -203668,7 +252476,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentDisciplineIncidentBehaviorAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentDisciplineIncidentBehaviorAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentDisciplineIncidentBehaviorAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentDisciplineIncidentBehaviorAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation" + } + } + }, + "description": "The JSON representation of the StudentDisciplineIncidentBehaviorAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentDisciplineIncidentBehaviorAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -203978,6 +252901,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey": { + "properties": { + "incidentIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -204068,7 +253057,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204111,7 +253100,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -204131,27 +253120,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentDisciplineIncidentNonOffenderAssociationsById", + "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentNonOffenderAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -204165,48 +253167,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentDisciplineIncidentNonOffenderAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentDisciplineIncidentNonOffenderAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentNonOffenderAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -204214,14 +253205,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -204233,20 +253224,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentDisciplineIncidentNonOffenderAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentDisciplineIncidentNonOffenderAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentDisciplineIncidentNonOffenderAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -204261,18 +253256,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation" - } - } - }, - "description": "The JSON representation of the StudentDisciplineIncidentNonOffenderAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentDisciplineIncidentNonOffenderAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -204290,7 +253273,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentDisciplineIncidentNonOffenderAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentDisciplineIncidentNonOffenderAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentDisciplineIncidentNonOffenderAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentDisciplineIncidentNonOffenderAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation" + } + } + }, + "description": "The JSON representation of the StudentDisciplineIncidentNonOffenderAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentDisciplineIncidentNonOffenderAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206731,6 +255829,67 @@ ], "type": "object" }, + "EdFi_StudentEducationOrganizationAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_StudentEducationOrganizationAssociation_TribalAffiliation": { "properties": { "tribalAffiliationDescriptor": { @@ -206947,7 +256106,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206990,7 +256149,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -207012,27 +256171,40 @@ "StudentIdentificationAndDemographics" ] }, - "/ed-fi/studentEducationOrganizationAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentEducationOrganizationAssociationsById", + "/ed-fi/studentEducationOrganizationAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -207046,48 +256218,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentEducationOrganizationAssociations" ] }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentEducationOrganizationAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentEducationOrganizationAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -207095,14 +256258,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -207114,20 +256277,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentEducationOrganizationAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentEducationOrganizationAssociation", + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentEducationOrganizationAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentEducationOrganizationAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -207142,18 +256311,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation" - } - } - }, - "description": "The JSON representation of the StudentEducationOrganizationAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentEducationOrganizationAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -207171,7 +256328,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentEducationOrganizationAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentEducationOrganizationAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentEducationOrganizationAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentEducationOrganizationAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation" + } + } + }, + "description": "The JSON representation of the StudentEducationOrganizationAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentEducationOrganizationAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -207555,6 +256827,77 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "responsibilityDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "responsibilityDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -207664,7 +257007,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207707,7 +257050,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -207728,27 +257071,40 @@ "Enrollment" ] }, - "/ed-fi/studentEducationOrganizationResponsibilityAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentEducationOrganizationResponsibilityAssociationsById", + "/ed-fi/studentEducationOrganizationResponsibilityAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationResponsibilityAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -207762,48 +257118,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentEducationOrganizationResponsibilityAssociations" ] }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/studentEducationOrganizationResponsibilityAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentEducationOrganizationResponsibilityAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationResponsibilityAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -207811,14 +257157,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -207830,20 +257176,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentEducationOrganizationResponsibilityAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentEducationOrganizationResponsibilityAssociation", + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/studentEducationOrganizationResponsibilityAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentEducationOrganizationResponsibilityAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -207858,18 +257209,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation" - } - } - }, - "description": "The JSON representation of the StudentEducationOrganizationResponsibilityAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentEducationOrganizationResponsibilityAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -207887,7 +257226,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentEducationOrganizationResponsibilityAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentEducationOrganizationResponsibilityAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentEducationOrganizationResponsibilityAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentEducationOrganizationResponsibilityAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation" + } + } + }, + "description": "The JSON representation of the StudentEducationOrganizationResponsibilityAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentEducationOrganizationResponsibilityAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -208329,6 +257783,73 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentGradebookEntry_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentGradebookEntry_TrackedChangeKey": { + "properties": { + "gradebookEntryIdentifier": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "gradebookEntryIdentifier", + "namespace", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentGradebookEntry_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -208500,7 +258021,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -208543,7 +258064,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -208565,27 +258086,40 @@ "Gradebook" ] }, - "/ed-fi/studentGradebookEntries/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentGradebookEntriesById", + "/ed-fi/studentGradebookEntries/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentGradebookEntriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -208599,48 +258133,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentGradebookEntries" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/studentGradebookEntries/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentGradebookEntriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentGradebookEntriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -208648,14 +258173,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentGradebookEntry" + "items": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -208667,20 +258192,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentGradebookEntries" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentGradebookEntry", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/studentGradebookEntries/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentGradebookEntriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -208695,18 +258226,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentGradebookEntry" - } - } - }, - "description": "The JSON representation of the StudentGradebookEntry resource to be created or updated.", - "required": true, - "x-bodyName": "StudentGradebookEntry" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -208724,7 +258243,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentGradebookEntries" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentGradebookEntriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentGradebookEntries" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentGradebookEntry", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry" + } + } + }, + "description": "The JSON representation of the StudentGradebookEntry resource to be created or updated.", + "required": true, + "x-bodyName": "StudentGradebookEntry" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209305,6 +258939,67 @@ "immunizationTypeDescriptor" ], "type": "object" + }, + "EdFi_StudentHealth_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentHealth_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentHealth_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -209412,7 +259107,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209455,7 +259150,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209476,27 +259171,40 @@ "StudentHealth" ] }, - "/ed-fi/studentHealths/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentHealthsById", + "/ed-fi/studentHealths/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHealthsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -209510,48 +259218,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentHealths" ] }, + "x-Ed-Fi-domains": [ + "StudentHealth" + ] + }, + "/ed-fi/studentHealths/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentHealthsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHealthsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -209559,14 +259257,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentHealth" + "items": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -209578,20 +259276,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentHealths" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentHealth", + "x-Ed-Fi-domains": [ + "StudentHealth" + ] + }, + "/ed-fi/studentHealths/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentHealthsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -209606,18 +259309,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentHealth" - } - } - }, - "description": "The JSON representation of the StudentHealth resource to be created or updated.", - "required": true, - "x-bodyName": "StudentHealth" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -209635,7 +259326,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentHealths" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentHealthsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentHealth" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentHealths" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentHealth", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentHealth" + } + } + }, + "description": "The JSON representation of the StudentHealth resource to be created or updated.", + "required": true, + "x-bodyName": "StudentHealth" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -210324,6 +260130,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentHomelessProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentHomelessProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentHomelessProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -210495,7 +260382,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -210538,7 +260425,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -210558,27 +260445,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentHomelessProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentHomelessProgramAssociationsById", + "/ed-fi/studentHomelessProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHomelessProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -210592,48 +260492,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentHomelessProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentHomelessProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentHomelessProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHomelessProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -210641,14 +260530,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -210660,20 +260549,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentHomelessProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentHomelessProgramAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentHomelessProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentHomelessProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -210688,18 +260581,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentHomelessProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentHomelessProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -210717,7 +260598,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentHomelessProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentHomelessProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentHomelessProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentHomelessProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentHomelessProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentHomelessProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -210990,6 +260986,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StudentIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -211106,7 +261163,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -211149,7 +261206,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -211169,27 +261226,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentIdentificationSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentIdentificationSystemsById", + "/ed-fi/studentIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIdentificationSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -211203,48 +261273,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentIdentificationSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentIdentificationSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentIdentificationSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIdentificationSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -211252,14 +261311,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -211271,20 +261330,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentIdentificationSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentIdentificationSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentIdentificationSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentIdentificationSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -211299,18 +261362,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor" - } - } - }, - "description": "The JSON representation of the StudentIdentificationSystem resource to be created or updated.", - "required": true, - "x-bodyName": "StudentIdentificationSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -211328,7 +261379,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentIdentificationSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentIdentificationSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentIdentificationSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentIdentificationSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor" + } + } + }, + "description": "The JSON representation of the StudentIdentificationSystem resource to be created or updated.", + "required": true, + "x-bodyName": "StudentIdentificationSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -211812,6 +261978,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentInterventionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentInterventionAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionIdentificationCode": { + "maxLength": 60, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionIdentificationCode", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentInterventionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -211940,7 +262172,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -211983,7 +262215,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -212005,27 +262237,40 @@ "StudentCohort" ] }, - "/ed-fi/studentInterventionAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentInterventionAssociationsById", + "/ed-fi/studentInterventionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -212039,48 +262284,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentInterventionAssociations" ] }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/studentInterventionAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentInterventionAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -212088,14 +262324,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -212107,20 +262343,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentInterventionAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentInterventionAssociation", + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/studentInterventionAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentInterventionAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -212135,18 +262377,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation" - } - } - }, - "description": "The JSON representation of the StudentInterventionAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentInterventionAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -212164,7 +262394,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentInterventionAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentInterventionAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentInterventionAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentInterventionAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation" + } + } + }, + "description": "The JSON representation of the StudentInterventionAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentInterventionAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -212584,6 +262929,82 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentInterventionAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "interventionIdentificationCode": { + "maxLength": 60, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "educationOrganizationId", + "eventDate", + "interventionIdentificationCode", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentInterventionAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -212730,7 +263151,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212773,7 +263194,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -212794,27 +263215,40 @@ "Intervention" ] }, - "/ed-fi/studentInterventionAttendanceEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentInterventionAttendanceEventsById", + "/ed-fi/studentInterventionAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAttendanceEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -212828,48 +263262,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentInterventionAttendanceEvents" ] }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/studentInterventionAttendanceEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentInterventionAttendanceEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAttendanceEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -212877,14 +263301,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent" + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -212896,20 +263320,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentInterventionAttendanceEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentInterventionAttendanceEvent", + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/studentInterventionAttendanceEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentInterventionAttendanceEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -212924,18 +263353,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent" - } - } - }, - "description": "The JSON representation of the StudentInterventionAttendanceEvent resource to be created or updated.", - "required": true, - "x-bodyName": "StudentInterventionAttendanceEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -212953,7 +263370,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentInterventionAttendanceEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentInterventionAttendanceEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentInterventionAttendanceEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentInterventionAttendanceEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent" + } + } + }, + "description": "The JSON representation of the StudentInterventionAttendanceEvent resource to be created or updated.", + "required": true, + "x-bodyName": "StudentInterventionAttendanceEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -213794,6 +264326,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -213957,7 +264570,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214000,7 +264613,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214020,27 +264633,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentLanguageInstructionProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentLanguageInstructionProgramAssociationsById", + "/ed-fi/studentLanguageInstructionProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentLanguageInstructionProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -214054,48 +264680,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentLanguageInstructionProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentLanguageInstructionProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentLanguageInstructionProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentLanguageInstructionProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -214103,14 +264718,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -214122,20 +264737,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentLanguageInstructionProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentLanguageInstructionProgramAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentLanguageInstructionProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentLanguageInstructionProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -214150,18 +264769,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentLanguageInstructionProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentLanguageInstructionProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -214179,7 +264786,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentLanguageInstructionProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentLanguageInstructionProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentLanguageInstructionProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentLanguageInstructionProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentLanguageInstructionProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentLanguageInstructionProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -215023,6 +265745,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -215249,7 +266052,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215292,7 +266095,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -215312,27 +266115,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentMigrantEducationProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentMigrantEducationProgramAssociationsById", + "/ed-fi/studentMigrantEducationProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentMigrantEducationProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -215346,48 +266162,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentMigrantEducationProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentMigrantEducationProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentMigrantEducationProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentMigrantEducationProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -215395,14 +266200,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -215414,20 +266219,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentMigrantEducationProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentMigrantEducationProgramAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentMigrantEducationProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentMigrantEducationProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -215442,18 +266251,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentMigrantEducationProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentMigrantEducationProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -215471,7 +266268,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentMigrantEducationProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentMigrantEducationProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentMigrantEducationProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentMigrantEducationProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentMigrantEducationProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentMigrantEducationProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -216247,6 +267159,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -216420,7 +267413,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -216463,7 +267456,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -216483,27 +267476,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentNeglectedOrDelinquentProgramAssociationsById", + "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentNeglectedOrDelinquentProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -216517,48 +267523,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentNeglectedOrDelinquentProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentNeglectedOrDelinquentProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentNeglectedOrDelinquentProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -216566,14 +267561,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -216585,20 +267580,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentNeglectedOrDelinquentProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentNeglectedOrDelinquentProgramAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentNeglectedOrDelinquentProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -216613,18 +267612,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentNeglectedOrDelinquentProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentNeglectedOrDelinquentProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -216642,7 +267629,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentNeglectedOrDelinquentProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentNeglectedOrDelinquentProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentNeglectedOrDelinquentProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentNeglectedOrDelinquentProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentNeglectedOrDelinquentProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentNeglectedOrDelinquentProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -216915,6 +268017,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StudentParticipationCodeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentParticipationCodeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StudentParticipationCodeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -217031,7 +268194,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217074,7 +268237,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -217094,27 +268257,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentParticipationCodeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentParticipationCodesById", + "/ed-fi/studentParticipationCodeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentParticipationCodesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -217128,48 +268304,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentParticipationCodeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentParticipationCodeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentParticipationCodesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentParticipationCodesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -217177,14 +268342,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -217196,20 +268361,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentParticipationCodeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentParticipationCode", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentParticipationCodeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentParticipationCodesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -217224,18 +268393,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor" - } - } - }, - "description": "The JSON representation of the StudentParticipationCode resource to be created or updated.", - "required": true, - "x-bodyName": "StudentParticipationCode" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -217253,7 +268410,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentParticipationCodeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentParticipationCodesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentParticipationCodeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentParticipationCode", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentParticipationCodeDescriptor" + } + } + }, + "description": "The JSON representation of the StudentParticipationCode resource to be created or updated.", + "required": true, + "x-bodyName": "StudentParticipationCode" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -217889,6 +269161,87 @@ "serviceDescriptor" ], "type": "object" + }, + "EdFi_StudentProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -218035,7 +269388,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218078,7 +269431,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -218105,27 +269458,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/studentProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentProgramAssociationsById", + "/ed-fi/studentProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -218139,48 +269505,44 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -218188,14 +269550,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -218207,20 +269569,31 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentProgramAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -218235,18 +269608,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -218264,7 +269625,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -218769,6 +270245,92 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentProgramAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentProgramAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "educationOrganizationId", + "eventDate", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentProgramAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -218935,7 +270497,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218978,7 +270540,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -219001,27 +270563,40 @@ "StudentAttendance" ] }, - "/ed-fi/studentProgramAttendanceEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentProgramAttendanceEventsById", + "/ed-fi/studentProgramAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAttendanceEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -219035,48 +270610,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentProgramAttendanceEvents" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentProgramAttendanceEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentProgramAttendanceEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAttendanceEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -219084,14 +270651,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent" + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -219103,20 +270670,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentProgramAttendanceEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentProgramAttendanceEvent", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentProgramAttendanceEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentProgramAttendanceEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -219131,18 +270705,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent" - } - } - }, - "description": "The JSON representation of the StudentProgramAttendanceEvent resource to be created or updated.", - "required": true, - "x-bodyName": "StudentProgramAttendanceEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -219160,7 +270722,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentProgramAttendanceEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentProgramAttendanceEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentProgramAttendanceEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentProgramAttendanceEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent" + } + } + }, + "description": "The JSON representation of the StudentProgramAttendanceEvent resource to be created or updated.", + "required": true, + "x-bodyName": "StudentProgramAttendanceEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -220191,6 +271868,97 @@ "programEvaluationObjectiveReference" ], "type": "object" + }, + "EdFi_StudentProgramEvaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentProgramEvaluation_TrackedChangeKey": { + "properties": { + "evaluationDate": { + "format": "date", + "type": "string" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "evaluationDate", + "programEducationOrganizationId", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentProgramEvaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -220387,7 +272155,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220430,7 +272198,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -220451,27 +272219,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/studentProgramEvaluations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentProgramEvaluationsById", + "/ed-fi/studentProgramEvaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramEvaluationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -220485,48 +272266,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentProgramEvaluations" ] }, + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/studentProgramEvaluations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentProgramEvaluationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramEvaluationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -220534,14 +272305,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -220553,20 +272324,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentProgramEvaluations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentProgramEvaluation", + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/studentProgramEvaluations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentProgramEvaluationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -220581,18 +272357,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation" - } - } - }, - "description": "The JSON representation of the StudentProgramEvaluation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentProgramEvaluation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -220610,7 +272374,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentProgramEvaluations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentProgramEvaluationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentProgramEvaluations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentProgramEvaluation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation" + } + } + }, + "description": "The JSON representation of the StudentProgramEvaluation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentProgramEvaluation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -221622,6 +273501,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSchoolAssociation_TrackedChangeKey": { + "properties": { + "entryDate": { + "format": "date", + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "entryDate", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -221918,7 +273863,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -221961,7 +273906,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -221986,27 +273931,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/studentSchoolAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSchoolAssociationsById", + "/ed-fi/studentSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -222020,48 +273978,42 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSchoolAssociations" ] }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentSchoolAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSchoolAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -222069,14 +274021,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -222088,20 +274040,29 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSchoolAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSchoolAssociation", + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentSchoolAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSchoolAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -222116,18 +274077,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation" - } - } - }, - "description": "The JSON representation of the StudentSchoolAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSchoolAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -222145,7 +274094,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSchoolAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSchoolAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSchoolAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSchoolAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation" + } + } + }, + "description": "The JSON representation of the StudentSchoolAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSchoolAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -222787,6 +274851,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSchoolAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "eventDate", + "schoolId", + "schoolYear", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSchoolAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -222959,7 +275104,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223002,7 +275147,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -223025,27 +275170,40 @@ "StudentAttendance" ] }, - "/ed-fi/studentSchoolAttendanceEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSchoolAttendanceEventsById", + "/ed-fi/studentSchoolAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAttendanceEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -223059,48 +275217,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSchoolAttendanceEvents" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentSchoolAttendanceEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSchoolAttendanceEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAttendanceEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -223108,14 +275258,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -223127,20 +275277,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSchoolAttendanceEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSchoolAttendanceEvent", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentSchoolAttendanceEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSchoolAttendanceEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -223155,18 +275312,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent" - } - } - }, - "description": "The JSON representation of the StudentSchoolAttendanceEvent resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSchoolAttendanceEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -223184,7 +275329,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSchoolAttendanceEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSchoolAttendanceEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSchoolAttendanceEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSchoolAttendanceEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent" + } + } + }, + "description": "The JSON representation of the StudentSchoolAttendanceEvent resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSchoolAttendanceEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -223877,6 +276137,87 @@ "schoolFoodServiceProgramServiceDescriptor" ], "type": "object" + }, + "EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -224031,7 +276372,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224074,7 +276415,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -224094,27 +276435,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentSchoolFoodServiceProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSchoolFoodServiceProgramAssociationsById", + "/ed-fi/studentSchoolFoodServiceProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolFoodServiceProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -224128,48 +276482,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSchoolFoodServiceProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentSchoolFoodServiceProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSchoolFoodServiceProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolFoodServiceProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -224177,14 +276520,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -224196,20 +276539,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSchoolFoodServiceProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSchoolFoodServiceProgramAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentSchoolFoodServiceProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSchoolFoodServiceProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -224224,18 +276571,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentSchoolFoodServiceProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSchoolFoodServiceProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -224253,7 +276588,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSchoolFoodServiceProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSchoolFoodServiceProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSchoolFoodServiceProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSchoolFoodServiceProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentSchoolFoodServiceProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSchoolFoodServiceProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -224828,6 +277278,92 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSectionAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -225001,7 +277537,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225044,7 +277580,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225073,27 +277609,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/studentSectionAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSectionAssociationsById", + "/ed-fi/studentSectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -225107,48 +277656,46 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSectionAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentSectionAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSectionAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -225156,14 +277703,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSectionAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -225175,20 +277722,33 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSectionAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSectionAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentSectionAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSectionAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -225203,18 +277763,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSectionAssociation" - } - } - }, - "description": "The JSON representation of the StudentSectionAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSectionAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -225232,7 +277780,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSectionAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSectionAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSectionAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSectionAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation" + } + } + }, + "description": "The JSON representation of the StudentSectionAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSectionAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225865,6 +278528,97 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSectionAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSectionAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "eventDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSectionAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -226057,7 +278811,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226100,7 +278854,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -226123,27 +278877,40 @@ "StudentAttendance" ] }, - "/ed-fi/studentSectionAttendanceEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSectionAttendanceEventsById", + "/ed-fi/studentSectionAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAttendanceEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -226157,48 +278924,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSectionAttendanceEvents" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentSectionAttendanceEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSectionAttendanceEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAttendanceEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -226206,14 +278965,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -226225,20 +278984,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSectionAttendanceEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSectionAttendanceEvent", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentSectionAttendanceEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSectionAttendanceEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -226253,18 +279019,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent" - } - } - }, - "description": "The JSON representation of the StudentSectionAttendanceEvent resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSectionAttendanceEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -226282,7 +279036,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSectionAttendanceEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSectionAttendanceEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSectionAttendanceEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSectionAttendanceEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent" + } + } + }, + "description": "The JSON representation of the StudentSectionAttendanceEvent resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSectionAttendanceEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -227547,6 +280416,87 @@ "specialEducationProgramServiceDescriptor" ], "type": "object" + }, + "EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -227807,7 +280757,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -227850,7 +280800,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -227871,27 +280821,40 @@ "SpecialEducation" ] }, - "/ed-fi/studentSpecialEducationProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSpecialEducationProgramAssociationsById", + "/ed-fi/studentSpecialEducationProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -227905,48 +280868,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSpecialEducationProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, + "/ed-fi/studentSpecialEducationProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSpecialEducationProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -227954,14 +280907,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -227973,20 +280926,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSpecialEducationProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSpecialEducationProgramAssociation", + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, + "/ed-fi/studentSpecialEducationProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSpecialEducationProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -228001,18 +280959,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentSpecialEducationProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSpecialEducationProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -228030,7 +280976,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSpecialEducationProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSpecialEducationProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSpecialEducationProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSpecialEducationProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentSpecialEducationProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSpecialEducationProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -228775,6 +281836,82 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey": { + "properties": { + "consentToEvaluationReceivedDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "consentToEvaluationReceivedDate", + "educationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -229018,7 +282155,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229061,7 +282198,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229081,27 +282218,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSpecialEducationProgramEligibilityAssociationsById", + "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramEligibilityAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -229115,48 +282265,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSpecialEducationProgramEligibilityAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSpecialEducationProgramEligibilityAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramEligibilityAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -229164,14 +282303,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -229183,20 +282322,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSpecialEducationProgramEligibilityAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSpecialEducationProgramEligibilityAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSpecialEducationProgramEligibilityAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -229211,18 +282354,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation" - } - } - }, - "description": "The JSON representation of the StudentSpecialEducationProgramEligibilityAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSpecialEducationProgramEligibilityAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -229240,7 +282371,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSpecialEducationProgramEligibilityAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSpecialEducationProgramEligibilityAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSpecialEducationProgramEligibilityAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSpecialEducationProgramEligibilityAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation" + } + } + }, + "description": "The JSON representation of the StudentSpecialEducationProgramEligibilityAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSpecialEducationProgramEligibilityAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229983,6 +283229,87 @@ "titleIPartAProgramServiceDescriptor" ], "type": "object" + }, + "EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -230138,7 +283465,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230181,7 +283508,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230201,27 +283528,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentTitleIPartAProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentTitleIPartAProgramAssociationsById", + "/ed-fi/studentTitleIPartAProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTitleIPartAProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -230235,48 +283575,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentTitleIPartAProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentTitleIPartAProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentTitleIPartAProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTitleIPartAProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -230284,14 +283613,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -230303,20 +283632,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentTitleIPartAProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentTitleIPartAProgramAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentTitleIPartAProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentTitleIPartAProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -230331,18 +283664,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentTitleIPartAProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentTitleIPartAProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -230360,7 +283681,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentTitleIPartAProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentTitleIPartAProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentTitleIPartAProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentTitleIPartAProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentTitleIPartAProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentTitleIPartAProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230859,6 +284295,67 @@ ], "type": "object" }, + "EdFi_StudentTransportation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentTransportation_TrackedChangeKey": { + "properties": { + "studentUniqueId": { + "maxLength": 32, + "type": "string" + }, + "transportationEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "studentUniqueId", + "transportationEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_StudentTransportation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_StudentTransportation_TravelDayofWeek": { "properties": { "travelDayofWeekDescriptor": { @@ -230991,7 +284488,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231034,7 +284531,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231055,27 +284552,40 @@ "Enrollment" ] }, - "/ed-fi/studentTransportations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentTransportationsById", + "/ed-fi/studentTransportations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTransportationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -231089,48 +284599,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentTransportations" ] }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/studentTransportations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentTransportationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTransportationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -231138,14 +284638,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentTransportation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -231157,20 +284657,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentTransportations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentTransportation", + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/studentTransportations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentTransportationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -231185,18 +284690,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentTransportation" - } - } - }, - "description": "The JSON representation of the StudentTransportation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentTransportation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -231214,7 +284707,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentTransportations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentTransportationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentTransportation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentTransportations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentTransportation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentTransportation" + } + } + }, + "description": "The JSON representation of the StudentTransportation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentTransportation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -232317,6 +285925,62 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_Student_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Student_TrackedChangeKey": { + "properties": { + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_Student_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -232560,7 +286224,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232603,7 +286267,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -232642,82 +286306,25 @@ "StudentTranscript" ] }, - "/ed-fi/students/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentsById", + "/ed-fi/students/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Updated" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "404": { - "$ref": "#/components/responses/NotFound" - }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "$ref": "#/components/parameters/MaxChangeVersion" }, - "500": { - "$ref": "#/components/responses/Error" - } - }, - "summary": "Deletes an existing resource using the resource identifier.", - "tags": [ - "students" - ] - }, - "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentsById", - "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/limit" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/offset" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -232725,68 +286332,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Student" + "items": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeDelete" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" - }, - "500": { - "$ref": "#/components/responses/Error" - } - }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", - "tags": [ - "students" - ] - }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudent", - "parameters": [ - { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/If-Match" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Student" - } - } - }, - "description": "The JSON representation of the Student resource to be created or updated.", - "required": true, - "x-bodyName": "Student" - }, - "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -232800,20 +286353,278 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Updates a resource based on the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "students" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "Enrollment", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/students/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "students" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "Enrollment", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/students/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "students" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Student" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "students" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Student" + } + } + }, + "description": "The JSON representation of the Student resource to be created or updated.", + "required": true, + "x-bodyName": "Student" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Updates a resource based on the resource identifier.", "tags": [ "students" ] @@ -233137,6 +286948,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SubmissionStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SubmissionStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SubmissionStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -233253,7 +287125,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233296,7 +287168,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -233316,6 +287188,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/submissionStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSubmissionStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "submissionStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/submissionStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSubmissionStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "submissionStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/submissionStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -233351,7 +287341,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -233383,15 +287373,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -233418,7 +287399,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233475,7 +287456,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -233700,6 +287681,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -233816,7 +287858,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233859,7 +287901,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -233879,6 +287921,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/supporterMilitaryConnectionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSupporterMilitaryConnectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "supporterMilitaryConnectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/supporterMilitaryConnectionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSupporterMilitaryConnectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "supporterMilitaryConnectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/supporterMilitaryConnectionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -233914,7 +288074,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -233946,15 +288106,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -233981,7 +288132,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234038,7 +288189,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -234263,6 +288414,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SurveyCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SurveyCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -234379,7 +288591,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234422,7 +288634,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -234442,6 +288654,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/surveyCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/surveyCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/surveyCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -234477,7 +288807,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -234509,15 +288839,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -234544,7 +288865,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234601,7 +288922,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -234881,6 +289202,78 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_SurveyCourseAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyCourseAssociation_TrackedChangeKey": { + "properties": { + "courseCode": { + "maxLength": 60, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "courseCode", + "educationOrganizationId", + "namespace", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyCourseAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -234982,7 +289375,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235025,7 +289418,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235046,6 +289439,126 @@ "Survey" ] }, + "/ed-fi/surveyCourseAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCourseAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyCourseAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyCourseAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCourseAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyCourseAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyCourseAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -235081,7 +289594,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235113,15 +289626,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -235148,7 +289652,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235205,7 +289709,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235423,6 +289927,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SurveyLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SurveyLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -235539,7 +290104,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235582,7 +290147,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235602,6 +290167,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/surveyLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/surveyLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/surveyLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -235637,7 +290320,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235669,15 +290352,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -235704,7 +290378,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235761,7 +290435,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236060,6 +290734,83 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_SurveyProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyProgramAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "namespace", + "programName", + "programTypeDescriptor", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -236171,7 +290922,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236214,7 +290965,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236235,6 +290986,126 @@ "Survey" ] }, + "/ed-fi/surveyProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -236270,7 +291141,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236302,15 +291173,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -236337,7 +291199,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236394,7 +291256,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236986,6 +291848,78 @@ "surveyQuestionResponseValueIdentifier" ], "type": "object" + }, + "EdFi_SurveyQuestionResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyQuestionResponse_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "questionCode": { + "maxLength": 60, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "namespace", + "questionCode", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyQuestionResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -237104,7 +292038,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237147,7 +292081,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237168,6 +292102,126 @@ "Survey" ] }, + "/ed-fi/surveyQuestionResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyQuestionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyQuestionResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyQuestionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyQuestionResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -237203,7 +292257,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237235,15 +292289,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -237270,7 +292315,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237327,7 +292372,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237873,6 +292918,73 @@ "sortOrder" ], "type": "object" + }, + "EdFi_SurveyQuestion_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyQuestion_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "questionCode": { + "maxLength": 60, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "namespace", + "questionCode", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyQuestion_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -237992,7 +293104,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238035,7 +293147,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238056,6 +293168,126 @@ "Survey" ] }, + "/ed-fi/surveyQuestions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyQuestions" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyQuestions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyQuestions" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyQuestions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -238091,7 +293323,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238123,15 +293355,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -238158,7 +293381,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238215,7 +293438,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238497,6 +293720,78 @@ "surveyResponseIdentifier" ], "type": "object" + }, + "EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -238598,7 +293893,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238641,7 +293936,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238662,6 +293957,126 @@ "Survey" ] }, + "/ed-fi/surveyResponseEducationOrganizationTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseEducationOrganizationTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponseEducationOrganizationTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseEducationOrganizationTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponseEducationOrganizationTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -238697,7 +294112,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238729,15 +294144,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -238764,7 +294170,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238821,7 +294227,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239094,6 +294500,78 @@ "surveyResponseIdentifier" ], "type": "object" + }, + "EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "namespace", + "staffUniqueId", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -239195,7 +294673,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239238,7 +294716,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239259,6 +294737,126 @@ "Survey" ] }, + "/ed-fi/surveyResponseStaffTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseStaffTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponseStaffTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseStaffTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponseStaffTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -239294,7 +294892,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239326,15 +294924,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -239361,7 +294950,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239418,7 +295007,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239893,6 +295482,73 @@ "surveyLevelDescriptor" ], "type": "object" + }, + "EdFi_SurveyResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponse_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -240060,7 +295716,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240103,7 +295759,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240124,6 +295780,126 @@ "Survey" ] }, + "/ed-fi/surveyResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -240159,7 +295935,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240191,15 +295967,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -240226,7 +295993,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240283,7 +296050,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240657,6 +296424,93 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_SurveySectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionAssociation_TrackedChangeKey": { + "properties": { + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "localCourseCode", + "namespace", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveySectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -240788,7 +296642,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240831,7 +296685,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240852,6 +296706,126 @@ "Survey" ] }, + "/ed-fi/surveySectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -240887,7 +296861,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240919,15 +296893,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -240954,7 +296919,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241011,7 +296976,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241332,6 +297297,83 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -241443,7 +297485,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241486,7 +297528,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241507,6 +297549,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseEducationOrganizationTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseEducationOrganizationTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -241542,7 +297704,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241574,15 +297736,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -241609,7 +297762,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241666,7 +297819,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241975,6 +298128,83 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "staffUniqueId", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -242086,7 +298316,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242129,7 +298359,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242150,6 +298380,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponseStaffTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseStaffTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponseStaffTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseStaffTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponseStaffTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -242185,7 +298535,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242217,15 +298567,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -242252,7 +298593,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242309,7 +298650,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242643,6 +298984,78 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponse_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -242753,7 +299166,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242796,7 +299209,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242817,6 +299230,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -242852,7 +299385,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242884,15 +299417,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -242919,7 +299443,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242976,7 +299500,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243217,6 +299741,73 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySection_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySection_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySection_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -243308,7 +299899,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243351,7 +299942,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243372,6 +299963,126 @@ "Survey" ] }, + "/ed-fi/surveySections/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySections" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySections/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySections" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySections/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -243407,7 +300118,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243439,15 +300150,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -243474,7 +300176,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243531,7 +300233,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243918,6 +300620,68 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_Survey_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Survey_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_Survey_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -244065,7 +300829,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244108,7 +300872,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244129,6 +300893,126 @@ "Survey" ] }, + "/ed-fi/surveys/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveysDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveys" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveys/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveysKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveys" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveys/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -244164,7 +301048,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244196,15 +301080,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -244231,7 +301106,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244288,7 +301163,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244532,6 +301407,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TeachingCredentialBasisDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -244648,7 +301584,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244691,7 +301627,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244711,6 +301647,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/teachingCredentialBasisDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialBasesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "teachingCredentialBasisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/teachingCredentialBasisDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialBasesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "teachingCredentialBasisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/teachingCredentialBasisDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -244746,7 +301800,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244778,15 +301832,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -244813,7 +301858,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244870,7 +301915,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245095,6 +302140,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TeachingCredentialDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TeachingCredentialDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TeachingCredentialDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -245211,7 +302317,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245254,7 +302360,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245274,6 +302380,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/teachingCredentialDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "teachingCredentialDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/teachingCredentialDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "teachingCredentialDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/teachingCredentialDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -245309,7 +302533,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245341,15 +302565,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -245376,7 +302591,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245433,7 +302648,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245658,6 +302873,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -245774,7 +303050,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245817,7 +303093,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245837,6 +303113,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/technicalSkillsAssessmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTechnicalSkillsAssessmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "technicalSkillsAssessmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/technicalSkillsAssessmentDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTechnicalSkillsAssessmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "technicalSkillsAssessmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/technicalSkillsAssessmentDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -245872,7 +303266,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245904,15 +303298,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -245939,7 +303324,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245996,7 +303381,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246221,6 +303606,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TelephoneNumberTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -246337,7 +303783,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246380,7 +303826,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246400,6 +303846,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/telephoneNumberTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTelephoneNumberTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "telephoneNumberTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/telephoneNumberTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTelephoneNumberTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "telephoneNumberTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/telephoneNumberTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -246435,7 +303999,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246467,15 +304031,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -246502,7 +304057,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246559,7 +304114,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246784,6 +304339,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TermDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TermDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TermDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -246900,7 +304516,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246943,7 +304559,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246963,6 +304579,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/termDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTermsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "termDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/termDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTermsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "termDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/termDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -246998,7 +304732,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247030,15 +304764,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -247065,7 +304790,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247122,7 +304847,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247347,6 +305072,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TitleIPartAParticipantDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -247463,7 +305249,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247506,7 +305292,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247526,6 +305312,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/titleIPartAParticipantDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAParticipantsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "titleIPartAParticipantDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/titleIPartAParticipantDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAParticipantsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "titleIPartAParticipantDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/titleIPartAParticipantDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -247561,7 +305465,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247593,15 +305497,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -247628,7 +305523,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247685,7 +305580,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247910,6 +305805,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -248026,7 +305982,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248069,7 +306025,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248089,6 +306045,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/titleIPartAProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "titleIPartAProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/titleIPartAProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "titleIPartAProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/titleIPartAProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -248124,7 +306198,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248156,15 +306230,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -248191,7 +306256,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248248,7 +306313,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248473,6 +306538,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -248589,7 +306715,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248632,7 +306758,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248652,6 +306778,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/titleIPartASchoolDesignationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartASchoolDesignationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "titleIPartASchoolDesignationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/titleIPartASchoolDesignationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartASchoolDesignationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "titleIPartASchoolDesignationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/titleIPartASchoolDesignationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -248687,7 +306931,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248719,15 +306963,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -248754,7 +306989,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248811,7 +307046,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249036,6 +307271,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -249152,7 +307448,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249195,7 +307491,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249215,6 +307511,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/transportationPublicExpenseEligibilityTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTransportationPublicExpenseEligibilityTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "transportationPublicExpenseEligibilityTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/transportationPublicExpenseEligibilityTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTransportationPublicExpenseEligibilityTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "transportationPublicExpenseEligibilityTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/transportationPublicExpenseEligibilityTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -249250,7 +307664,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249282,15 +307696,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -249317,7 +307722,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249374,7 +307779,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249599,6 +308004,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TransportationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TransportationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TransportationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -249715,7 +308181,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249758,7 +308224,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249778,6 +308244,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/transportationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTransportationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "transportationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/transportationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTransportationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "transportationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/transportationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -249813,7 +308397,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249845,15 +308429,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -249880,7 +308455,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249937,7 +308512,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250162,6 +308737,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TravelDayofWeekDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TravelDayofWeekDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TravelDayofWeekDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -250278,7 +308914,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250321,7 +308957,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250341,6 +308977,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/travelDayofWeekDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTravelDayofWeeksDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "travelDayofWeekDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/travelDayofWeekDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTravelDayofWeeksKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "travelDayofWeekDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/travelDayofWeekDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -250376,7 +309130,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250408,15 +309162,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -250443,7 +309188,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250500,7 +309245,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250725,6 +309470,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TravelDirectionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TravelDirectionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TravelDirectionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -250841,7 +309647,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250884,7 +309690,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250904,6 +309710,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/travelDirectionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTravelDirectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "travelDirectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/travelDirectionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTravelDirectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "travelDirectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/travelDirectionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -250939,7 +309863,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250971,15 +309895,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -251006,7 +309921,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251063,7 +309978,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -251288,6 +310203,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TribalAffiliationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TribalAffiliationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TribalAffiliationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -251404,7 +310380,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251447,7 +310423,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -251467,6 +310443,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/tribalAffiliationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTribalAffiliationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "tribalAffiliationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/tribalAffiliationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTribalAffiliationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "tribalAffiliationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/tribalAffiliationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -251502,7 +310596,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -251534,15 +310628,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -251569,7 +310654,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251626,7 +310711,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -251851,6 +310936,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_VisaDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_VisaDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_VisaDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -251967,7 +311113,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252010,7 +311156,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252030,6 +311176,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/visaDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getVisasDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "visaDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/visaDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getVisasKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "visaDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/visaDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -252065,7 +311329,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252097,15 +311361,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -252132,7 +311387,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252189,7 +311444,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252414,6 +311669,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_WeaponDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_WeaponDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_WeaponDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -252530,7 +311846,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252573,7 +311889,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252593,6 +311909,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/weaponDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getWeaponsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "weaponDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/weaponDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getWeaponsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "weaponDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/weaponDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -252628,7 +312062,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252660,15 +312094,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -252695,7 +312120,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252752,7 +312177,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" diff --git a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_2/tpdm-api-schema-authoritative.json b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_2/tpdm-api-schema-authoritative.json index b6212a136..d6874bbf6 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_2/tpdm-api-schema-authoritative.json +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_2/tpdm-api-schema-authoritative.json @@ -263,6 +263,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_AccreditationStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_AccreditationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_AccreditationStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_AccreditationStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_AccreditationStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_AccreditationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -379,7 +440,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -422,7 +483,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -442,6 +503,124 @@ "x-Ed-Fi-domains": [ ] }, + "/tpdm/accreditationStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMAccreditationStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_AccreditationStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "accreditationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/accreditationStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMAccreditationStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_AccreditationStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "accreditationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/tpdm/accreditationStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -477,7 +656,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -509,15 +688,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -544,7 +714,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -601,7 +771,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -828,6 +998,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_AidTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_AidTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_AidTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_AidTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_AidTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_AidTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -944,7 +1175,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -987,7 +1218,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1007,27 +1238,40 @@ "x-Ed-Fi-domains": [ ] }, - "/tpdm/aidTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_TPDMAidTypesById", + "/tpdm/aidTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMAidTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_AidTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -1041,48 +1285,144 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "aidTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/aidTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_TPDMAidTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMAidTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_AidTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "aidTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/aidTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_TPDMAidTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "aidTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_TPDMAidTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" } + }, + { + "$ref": "#/components/parameters/If-None-Match" } ], "responses": { @@ -1109,7 +1449,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1166,7 +1506,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1767,6 +2107,84 @@ "programTypeDescriptor" ], "type": "object" + }, + "Tpdm_CandidateEducatorPreparationProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_CandidateEducatorPreparationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_CandidateEducatorPreparationProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "candidateIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "beginDate", + "candidateIdentifier", + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "Tpdm_CandidateEducatorPreparationProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_CandidateEducatorPreparationProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_CandidateEducatorPreparationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -1906,7 +2324,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1949,7 +2367,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1970,27 +2388,40 @@ "TeacherPreparation" ] }, - "/tpdm/candidateEducatorPreparationProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_TPDMCandidateEducatorPreparationProgramAssociationsById", + "/tpdm/candidateEducatorPreparationProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCandidateEducatorPreparationProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_CandidateEducatorPreparationProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2004,48 +2435,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "candidateEducatorPreparationProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/candidateEducatorPreparationProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_TPDMCandidateEducatorPreparationProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCandidateEducatorPreparationProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -2053,14 +2474,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tpdm_CandidateEducatorPreparationProgramAssociation" + "items": { + "$ref": "#/components/schemas/Tpdm_CandidateEducatorPreparationProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2072,24 +2493,132 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "candidateEducatorPreparationProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "put_TPDMCandidateEducatorPreparationProgramAssociation", - "parameters": [ - { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/candidateEducatorPreparationProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_TPDMCandidateEducatorPreparationProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "candidateEducatorPreparationProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_TPDMCandidateEducatorPreparationProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_CandidateEducatorPreparationProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "candidateEducatorPreparationProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "put_TPDMCandidateEducatorPreparationProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", "name": "id", "required": true, "schema": { @@ -2129,7 +2658,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4121,6 +4650,63 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "Tpdm_Candidate_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_Candidate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_Candidate_TrackedChangeKey": { + "properties": { + "candidateIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "candidateIdentifier" + ], + "type": "object" + }, + "Tpdm_Candidate_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_Candidate_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_Candidate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -4426,7 +5012,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4469,7 +5055,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4490,27 +5076,40 @@ "TeacherPreparation" ] }, - "/tpdm/candidates/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_TPDMCandidatesById", + "/tpdm/candidates/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCandidatesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_Candidate_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4524,48 +5123,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "candidates" ] }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/candidates/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_TPDMCandidatesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCandidatesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -4573,14 +5162,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tpdm_Candidate" + "items": { + "$ref": "#/components/schemas/Tpdm_Candidate_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4592,20 +5181,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "candidates" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "put_TPDMCandidate", + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/candidates/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_TPDMCandidatesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -4620,18 +5214,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_Candidate" - } - } - }, - "description": "The JSON representation of the Candidate resource to be created or updated.", - "required": true, - "x-bodyName": "Candidate" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -4649,7 +5231,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "candidates" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_TPDMCandidatesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_Candidate" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "candidates" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "put_TPDMCandidate", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_Candidate" + } + } + }, + "description": "The JSON representation of the Candidate resource to be created or updated.", + "required": true, + "x-bodyName": "Candidate" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5010,6 +5707,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_CertificationRouteDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_CertificationRouteDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_CertificationRouteDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -5126,7 +5884,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5169,7 +5927,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5189,27 +5947,40 @@ "x-Ed-Fi-domains": [ ] }, - "/tpdm/certificationRouteDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_TPDMCertificationRoutesById", + "/tpdm/certificationRouteDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCertificationRoutesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -5223,48 +5994,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "certificationRouteDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/certificationRouteDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_TPDMCertificationRoutesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCertificationRoutesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -5272,14 +6032,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor" + "items": { + "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -5291,20 +6051,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "certificationRouteDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "put_TPDMCertificationRoute", + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/certificationRouteDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_TPDMCertificationRoutesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -5319,15 +6083,118 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor" - } - } + "responses": { + "204": { + "$ref": "#/components/responses/Updated" }, - "description": "The JSON representation of the CertificationRoute resource to be created or updated.", + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "certificationRouteDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_TPDMCertificationRoutesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "certificationRouteDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "put_TPDMCertificationRoute", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor" + } + } + }, + "description": "The JSON representation of the CertificationRoute resource to be created or updated.", "required": true, "x-bodyName": "CertificationRoute" }, @@ -5348,7 +6215,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5575,6 +6442,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_CoteachingStyleObservedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_CoteachingStyleObservedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_CoteachingStyleObservedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -5691,7 +6619,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5734,7 +6662,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5754,27 +6682,40 @@ "x-Ed-Fi-domains": [ ] }, - "/tpdm/coteachingStyleObservedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_TPDMCoteachingStyleObservedsById", + "/tpdm/coteachingStyleObservedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCoteachingStyleObservedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -5788,48 +6729,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "coteachingStyleObservedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/coteachingStyleObservedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_TPDMCoteachingStyleObservedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCoteachingStyleObservedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -5837,14 +6767,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor" + "items": { + "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -5856,20 +6786,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "coteachingStyleObservedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "put_TPDMCoteachingStyleObserved", + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/coteachingStyleObservedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_TPDMCoteachingStyleObservedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -5884,18 +6818,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor" - } - } - }, - "description": "The JSON representation of the CoteachingStyleObserved resource to be created or updated.", - "required": true, - "x-bodyName": "CoteachingStyleObserved" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -5913,7 +6835,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5925,15 +6847,130 @@ "$ref": "#/components/responses/Error" } }, - "summary": "Updates a resource based on the resource identifier.", + "summary": "Deletes an existing resource using the resource identifier.", "tags": [ "coteachingStyleObservedDescriptors" ] }, - "x-Ed-Fi-domains": [ - ] - } - }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_TPDMCoteachingStyleObservedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "coteachingStyleObservedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "put_TPDMCoteachingStyleObserved", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor" + } + } + }, + "description": "The JSON representation of the CoteachingStyleObserved resource to be created or updated.", + "required": true, + "x-bodyName": "CoteachingStyleObserved" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Updates a resource based on the resource identifier.", + "tags": [ + "coteachingStyleObservedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + } + }, "tags": [ { "description": "A type of co-teaching observed as part of the performance evaluation.", @@ -6140,6 +7177,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_CredentialStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_CredentialStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_CredentialStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_CredentialStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_CredentialStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_CredentialStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -6256,7 +7354,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6299,7 +7397,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6319,6 +7417,124 @@ "x-Ed-Fi-domains": [ ] }, + "/tpdm/credentialStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCredentialStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_CredentialStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "credentialStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/credentialStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCredentialStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_CredentialStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "credentialStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/tpdm/credentialStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -6354,7 +7570,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6386,15 +7602,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -6421,7 +7628,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6478,7 +7685,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7184,6 +8391,73 @@ "programTypeDescriptor" ], "type": "object" + }, + "Tpdm_EducatorPreparationProgram_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EducatorPreparationProgram_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "Tpdm_EducatorPreparationProgram_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -7238,32 +8512,144 @@ "x-Ed-Fi-isIdentity": true }, { - "description": "The type of program.", - "in": "query", - "name": "programTypeDescriptor", - "schema": { - "maxLength": 306, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "description": "The type of program.", + "in": "query", + "name": "programTypeDescriptor", + "schema": { + "maxLength": 306, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "The current accreditation status of the Educator Preparation Program.", + "in": "query", + "name": "accreditationStatusDescriptor", + "schema": { + "maxLength": 306, + "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.", + "in": "query", + "name": "programId", + "schema": { + "maxLength": 20, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "educatorPreparationPrograms" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEducatorPreparationProgram", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram" + } + } + }, + "description": "The JSON representation of the EducatorPreparationProgram resource to be created or updated.", + "required": true, + "x-bodyName": "EducatorPreparationProgram" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "educatorPreparationPrograms" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/educatorPreparationPrograms/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEducatorPreparationProgramsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "The current accreditation status of the Educator Preparation Program.", - "in": "query", - "name": "accreditationStatusDescriptor", - "schema": { - "maxLength": 306, - "type": "string" - } + "$ref": "#/components/parameters/limit" }, { - "description": "A unique number or alphanumeric code assigned to a program by a school, school system, a state, or other agency or entity.", - "in": "query", - "name": "programId", - "schema": { - "maxLength": 20, - "type": "string" - } + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -7272,16 +8658,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram" + "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7293,38 +8676,55 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educatorPreparationPrograms" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEducatorPreparationProgram", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/educatorPreparationPrograms/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEducatorPreparationProgramsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EducatorPreparationProgram resource to be created or updated.", - "required": true, - "x-bodyName": "EducatorPreparationProgram" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7335,20 +8735,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educatorPreparationPrograms" ] @@ -7392,7 +8786,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7424,15 +8818,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -7459,7 +8844,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7516,7 +8901,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7741,6 +9126,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_EducatorRoleDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EducatorRoleDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_EducatorRoleDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -7811,23 +9257,134 @@ } }, { - "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", - "in": "query", - "name": "namespace", - "schema": { - "maxLength": 255, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", + "in": "query", + "name": "namespace", + "schema": { + "maxLength": 255, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "educatorRoleDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEducatorRole", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor" + } + } + }, + "description": "The JSON representation of the EducatorRole resource to be created or updated.", + "required": true, + "x-bodyName": "EducatorRole" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "educatorRoleDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/educatorRoleDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEducatorRolesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -7836,16 +9393,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor" + "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7857,38 +9411,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educatorRoleDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEducatorRole", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/educatorRoleDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEducatorRolesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EducatorRole resource to be created or updated.", - "required": true, - "x-bodyName": "EducatorRole" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7899,20 +9469,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educatorRoleDescriptors" ] @@ -7955,7 +9519,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7987,15 +9551,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -8022,7 +9577,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8079,7 +9634,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8306,6 +9861,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_EnglishLanguageExamDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EnglishLanguageExamDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_EnglishLanguageExamDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -8367,32 +9983,143 @@ } }, { - "description": "The end date of the period when the descriptor is in effect.", - "in": "query", - "name": "effectiveEndDate", - "schema": { - "format": "date", - "type": "string" - } + "description": "The end date of the period when the descriptor is in effect.", + "in": "query", + "name": "effectiveEndDate", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", + "in": "query", + "name": "namespace", + "schema": { + "maxLength": 255, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "englishLanguageExamDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEnglishLanguageExam", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor" + } + } + }, + "description": "The JSON representation of the EnglishLanguageExam resource to be created or updated.", + "required": true, + "x-bodyName": "EnglishLanguageExam" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "englishLanguageExamDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/englishLanguageExamDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEnglishLanguageExamsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", - "in": "query", - "name": "namespace", - "schema": { - "maxLength": 255, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "$ref": "#/components/parameters/limit" }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -8401,16 +10128,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor" + "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -8422,38 +10146,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "englishLanguageExamDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEnglishLanguageExam", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/englishLanguageExamDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEnglishLanguageExamsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EnglishLanguageExam resource to be created or updated.", - "required": true, - "x-bodyName": "EnglishLanguageExam" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -8464,20 +10204,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "englishLanguageExamDescriptors" ] @@ -8520,7 +10254,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8552,15 +10286,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -8587,7 +10312,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8644,7 +10369,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8871,6 +10596,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_EppProgramPathwayDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EppProgramPathwayDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_EppProgramPathwayDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -8941,23 +10727,134 @@ } }, { - "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", - "in": "query", - "name": "namespace", - "schema": { - "maxLength": 255, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", + "in": "query", + "name": "namespace", + "schema": { + "maxLength": 255, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "eppProgramPathwayDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEPPProgramPathway", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor" + } + } + }, + "description": "The JSON representation of the EPPProgramPathway resource to be created or updated.", + "required": true, + "x-bodyName": "EPPProgramPathway" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "eppProgramPathwayDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/eppProgramPathwayDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEPPProgramPathwaysDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -8966,16 +10863,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor" + "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -8987,38 +10881,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "eppProgramPathwayDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEPPProgramPathway", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/eppProgramPathwayDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEPPProgramPathwaysKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EPPProgramPathway resource to be created or updated.", - "required": true, - "x-bodyName": "EPPProgramPathway" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -9029,20 +10939,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "eppProgramPathwayDescriptors" ] @@ -9085,7 +10989,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9117,15 +11021,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -9152,7 +11047,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9209,7 +11104,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9436,6 +11331,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_EvaluationElementRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationElementRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_EvaluationElementRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -9551,39 +11507,163 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "evaluationElementRatingLevelDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEvaluationElementRatingLevel", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRatingLevelDescriptor" + } + } + }, + "description": "The JSON representation of the EvaluationElementRatingLevel resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationElementRatingLevel" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluationElementRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationElementRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationElementRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationElementRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationElementRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationElementRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" }, - "500": { - "$ref": "#/components/responses/Error" + { + "$ref": "#/components/parameters/totalCount" } - }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", - "tags": [ - "evaluationElementRatingLevelDescriptors" - ] - }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEvaluationElementRatingLevel", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EvaluationElementRatingLevelDescriptor" - } - } - }, - "description": "The JSON representation of the EvaluationElementRatingLevel resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationElementRatingLevel" - }, + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -9594,20 +11674,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationElementRatingLevelDescriptors" ] @@ -9650,7 +11724,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9682,15 +11756,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -9717,7 +11782,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9774,7 +11839,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10596,6 +12661,121 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "Tpdm_EvaluationElementRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationElementRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationDate": { + "format": "date-time", + "type": "string" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationDate", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_EvaluationElementRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -10808,16 +12988,125 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_EvaluationElementRating" + "$ref": "#/components/schemas/Tpdm_EvaluationElementRating" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "evaluationElementRatings" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEvaluationElementRating", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRating" + } + } + }, + "description": "The JSON representation of the EvaluationElementRating resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationElementRating" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluationElementRatings" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluationElementRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationElementRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRating_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -10829,38 +13118,55 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationElementRatings" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEvaluationElementRating", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EvaluationElementRating" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluationElementRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationElementRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EvaluationElementRating resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationElementRating" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -10871,20 +13177,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationElementRatings" ] @@ -10928,7 +13228,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10960,15 +13260,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -10995,7 +13286,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -11052,7 +13343,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -11693,6 +13984,106 @@ "evaluationObjectiveTitle" ], "type": "object" + }, + "Tpdm_EvaluationElement_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationElement_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_EvaluationElement_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElement_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -11883,38 +14274,164 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "evaluationElements" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEvaluationElement", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EvaluationElement" + } + } + }, + "description": "The JSON representation of the EvaluationElement resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationElement" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluationElements" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluationElements/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationElementsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationElement_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationElements" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEvaluationElement", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EvaluationElement" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluationElements/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationElementsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EvaluationElement resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationElement" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationElement_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -11925,20 +14442,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationElements" ] @@ -11982,7 +14493,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -12014,15 +14525,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -12049,7 +14551,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -12106,7 +14608,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -12876,6 +15378,115 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "Tpdm_EvaluationObjectiveRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjectiveRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationObjectiveRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationDate": { + "format": "date-time", + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationDate", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_EvaluationObjectiveRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjectiveRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjectiveRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -13068,38 +15679,164 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "evaluationObjectiveRatings" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEvaluationObjectiveRating", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjectiveRating" + } + } + }, + "description": "The JSON representation of the EvaluationObjectiveRating resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationObjectiveRating" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluationObjectiveRatings" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluationObjectiveRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationObjectiveRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjectiveRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationObjectiveRatings" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEvaluationObjectiveRating", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EvaluationObjectiveRating" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluationObjectiveRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationObjectiveRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EvaluationObjectiveRating resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationObjectiveRating" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjectiveRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -13110,20 +15847,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationObjectiveRatings" ] @@ -13167,7 +15898,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -13199,15 +15930,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -13234,7 +15956,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -13291,7 +16013,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -13904,6 +16626,100 @@ "evaluationObjectiveTitle" ], "type": "object" + }, + "Tpdm_EvaluationObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationObjective_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_EvaluationObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -14047,22 +16863,134 @@ } }, { - "description": "The minimum summary numerical rating or score for the evaluation Objective. If omitted, assumed to be 0.0.", - "in": "query", - "name": "minRating", - "schema": { - "format": "double", - "type": "number" - } + "description": "The minimum summary numerical rating or score for the evaluation Objective. If omitted, assumed to be 0.0.", + "in": "query", + "name": "minRating", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "The sort order of this Evaluation Objective.", + "in": "query", + "name": "sortOrder", + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjective" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "evaluationObjectives" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEvaluationObjective", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjective" + } + } + }, + "description": "The JSON representation of the EvaluationObjective resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationObjective" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluationObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluationObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationObjectivesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" }, { - "description": "The sort order of this Evaluation Objective.", - "in": "query", - "name": "sortOrder", - "schema": { - "format": "int32", - "type": "integer" - } + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -14071,16 +16999,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_EvaluationObjective" + "$ref": "#/components/schemas/Tpdm_EvaluationObjective_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -14092,38 +17017,55 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationObjectives" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEvaluationObjective", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EvaluationObjective" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluationObjectives/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationObjectivesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EvaluationObjective resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationObjective" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjective_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -14134,20 +17076,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationObjectives" ] @@ -14191,7 +17127,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14223,15 +17159,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -14258,7 +17185,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14315,7 +17242,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14595,6 +17522,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_EvaluationPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_EvaluationPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -14647,41 +17635,152 @@ } }, { - "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", - "in": "query", - "name": "effectiveBeginDate", - "schema": { - "format": "date", - "type": "string" - } + "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", + "in": "query", + "name": "effectiveBeginDate", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "The end date of the period when the descriptor is in effect.", + "in": "query", + "name": "effectiveEndDate", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", + "in": "query", + "name": "namespace", + "schema": { + "maxLength": 255, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "evaluationPeriodDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEvaluationPeriod", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor" + } + } + }, + "description": "The JSON representation of the EvaluationPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationPeriod" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluationPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationPeriodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "The end date of the period when the descriptor is in effect.", - "in": "query", - "name": "effectiveEndDate", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/parameters/limit" }, { - "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", - "in": "query", - "name": "namespace", - "schema": { - "maxLength": 255, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "$ref": "#/components/parameters/offset" }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -14690,16 +17789,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor" + "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -14711,38 +17807,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationPeriodDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEvaluationPeriod", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationPeriodDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationPeriodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EvaluationPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationPeriod" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -14753,20 +17865,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationPeriodDescriptors" ] @@ -14809,7 +17915,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14841,15 +17947,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -14876,7 +17973,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14933,7 +18030,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15160,6 +18257,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_EvaluationRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_EvaluationRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -15276,7 +18434,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15318,20 +18476,138 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluationRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationRatingLevelDescriptors" ] @@ -15374,7 +18650,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15406,15 +18682,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -15441,7 +18708,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15498,7 +18765,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15725,6 +18992,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_EvaluationRatingStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationRatingStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_EvaluationRatingStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -15841,7 +19169,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15884,7 +19212,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15904,6 +19232,124 @@ "x-Ed-Fi-domains": [ ] }, + "/tpdm/evaluationRatingStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationRatingStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationRatingStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationRatingStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationRatingStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationRatingStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/tpdm/evaluationRatingStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -15939,7 +19385,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15971,15 +19417,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -16006,7 +19443,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16063,7 +19500,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17017,8 +20454,111 @@ } }, "required": [ - "firstName", - "lastSurname" + "firstName", + "lastSurname" + ], + "type": "object" + }, + "Tpdm_EvaluationRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationDate": { + "format": "date-time", + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationDate", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_EvaluationRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" ], "type": "object" } @@ -17260,7 +20800,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17303,7 +20843,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17323,6 +20863,124 @@ "x-Ed-Fi-domains": [ ] }, + "/tpdm/evaluationRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationRatings" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationRatings" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/tpdm/evaluationRatings/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -17358,7 +21016,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17390,15 +21048,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -17425,7 +21074,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17482,7 +21131,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17796,6 +21445,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_EvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_EvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -17891,16 +21601,124 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor" + "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "evaluationTypeDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEvaluationType", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor" + } + } + }, + "description": "The JSON representation of the EvaluationType resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationType" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -17912,38 +21730,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationTypeDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEvaluationType", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EvaluationType resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationType" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -17954,20 +21788,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationTypeDescriptors" ] @@ -18010,7 +21838,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18042,15 +21870,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -18077,7 +21896,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18134,7 +21953,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18669,6 +22488,94 @@ "termDescriptor" ], "type": "object" + }, + "Tpdm_Evaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_Evaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_Evaluation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_Evaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_Evaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_Evaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -18810,13 +22717,125 @@ } }, { - "description": "The minimum summary numerical rating or score for the evaluation. If omitted, assumed to be 0.0.", - "in": "query", - "name": "minRating", - "schema": { - "format": "double", - "type": "number" - } + "description": "The minimum summary numerical rating or score for the evaluation. If omitted, assumed to be 0.0.", + "in": "query", + "name": "minRating", + "schema": { + "format": "double", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_Evaluation" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "evaluations" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEvaluation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_Evaluation" + } + } + }, + "description": "The JSON representation of the Evaluation resource to be created or updated.", + "required": true, + "x-bodyName": "Evaluation" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluations" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -18825,16 +22844,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_Evaluation" + "$ref": "#/components/schemas/Tpdm_Evaluation_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -18846,38 +22862,55 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluations" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEvaluation", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_Evaluation" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the Evaluation resource to be created or updated.", - "required": true, - "x-bodyName": "Evaluation" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_Evaluation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -18888,20 +22921,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluations" ] @@ -18945,7 +22972,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18977,15 +23004,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -19012,7 +23030,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19069,7 +23087,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19449,6 +23467,72 @@ "studentUniqueId" ], "type": "object" + }, + "Tpdm_FinancialAid_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_FinancialAid_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_FinancialAid_TrackedChangeKey": { + "properties": { + "aidTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "beginDate": { + "format": "date", + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "aidTypeDescriptor", + "beginDate", + "studentUniqueId" + ], + "type": "object" + }, + "Tpdm_FinancialAid_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_FinancialAid_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_FinancialAid_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -19512,39 +23596,151 @@ "x-Ed-Fi-isIdentity": true }, { - "description": "The amount of financial aid awarded to a person for the term/year.", - "in": "query", - "name": "aidAmount", - "schema": { - "format": "double", - "type": "number" - } + "description": "The amount of financial aid awarded to a person for the term/year.", + "in": "query", + "name": "aidAmount", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "The description of the condition (e.g., placement in a high need school) under which the aid was given.", + "in": "query", + "name": "aidConditionDescription", + "schema": { + "maxLength": 1024, + "type": "string" + } + }, + { + "description": "The date the award was removed. Note: Date interpretation may vary. Ed-Fi recommends inclusive dates, but states may define dates as inclusive or exclusive. For calculations, align with local guidelines.", + "in": "query", + "name": "endDate", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "Indicates a person who receives Pell Grant aid.", + "in": "query", + "name": "pellGrantRecipient", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_FinancialAid" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "financialAids" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMFinancialAid", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_FinancialAid" + } + } + }, + "description": "The JSON representation of the FinancialAid resource to be created or updated.", + "required": true, + "x-bodyName": "FinancialAid" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "financialAids" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/financialAids/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMFinancialAidsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "The description of the condition (e.g., placement in a high need school) under which the aid was given.", - "in": "query", - "name": "aidConditionDescription", - "schema": { - "maxLength": 1024, - "type": "string" - } + "$ref": "#/components/parameters/limit" }, { - "description": "The date the award was removed. Note: Date interpretation may vary. Ed-Fi recommends inclusive dates, but states may define dates as inclusive or exclusive. For calculations, align with local guidelines.", - "in": "query", - "name": "endDate", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/parameters/offset" }, { - "description": "Indicates a person who receives Pell Grant aid.", - "in": "query", - "name": "pellGrantRecipient", - "schema": { - "type": "boolean" - } + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -19553,16 +23749,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_FinancialAid" + "$ref": "#/components/schemas/Tpdm_FinancialAid_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -19574,38 +23767,55 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "financialAids" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMFinancialAid", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_FinancialAid" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/financialAids/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMFinancialAidsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the FinancialAid resource to be created or updated.", - "required": true, - "x-bodyName": "FinancialAid" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_FinancialAid_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -19616,20 +23826,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "financialAids" ] @@ -19673,7 +23877,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19705,15 +23909,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -19740,7 +23935,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19797,7 +23992,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20031,6 +24226,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_GenderDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_GenderDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_GenderDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_GenderDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_GenderDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_GenderDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -20111,13 +24367,124 @@ "x-Ed-Fi-isIdentity": true }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_GenderDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "genderDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMGender", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_GenderDescriptor" + } + } + }, + "description": "The JSON representation of the Gender resource to be created or updated.", + "required": true, + "x-bodyName": "Gender" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "genderDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/genderDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMGendersDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -20126,16 +24493,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_GenderDescriptor" + "$ref": "#/components/schemas/Tpdm_GenderDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20147,38 +24511,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "genderDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMGender", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_GenderDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/genderDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMGendersKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the Gender resource to be created or updated.", - "required": true, - "x-bodyName": "Gender" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_GenderDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20189,20 +24569,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "genderDescriptors" ] @@ -20245,7 +24619,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20277,15 +24651,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -20312,7 +24677,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20369,7 +24734,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20596,6 +24961,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_ObjectiveRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_ObjectiveRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_ObjectiveRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -20639,50 +25065,161 @@ "x-Ed-Fi-isIdentity": true }, { - "description": "The description of the descriptor.", - "in": "query", - "name": "description", - "schema": { - "maxLength": 1024, - "type": "string" - } + "description": "The description of the descriptor.", + "in": "query", + "name": "description", + "schema": { + "maxLength": 1024, + "type": "string" + } + }, + { + "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", + "in": "query", + "name": "effectiveBeginDate", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "The end date of the period when the descriptor is in effect.", + "in": "query", + "name": "effectiveEndDate", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", + "in": "query", + "name": "namespace", + "schema": { + "maxLength": 255, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "objectiveRatingLevelDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMObjectiveRatingLevel", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor" + } + } + }, + "description": "The JSON representation of the ObjectiveRatingLevel resource to be created or updated.", + "required": true, + "x-bodyName": "ObjectiveRatingLevel" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "objectiveRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/objectiveRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMObjectiveRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, { - "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", - "in": "query", - "name": "effectiveBeginDate", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "The end date of the period when the descriptor is in effect.", - "in": "query", - "name": "effectiveEndDate", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/parameters/limit" }, { - "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", - "in": "query", - "name": "namespace", - "schema": { - "maxLength": 255, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "$ref": "#/components/parameters/offset" }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -20691,16 +25228,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor" + "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20712,38 +25246,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "objectiveRatingLevelDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMObjectiveRatingLevel", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/objectiveRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMObjectiveRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the ObjectiveRatingLevel resource to be created or updated.", - "required": true, - "x-bodyName": "ObjectiveRatingLevel" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20754,20 +25304,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "objectiveRatingLevelDescriptors" ] @@ -20810,7 +25354,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20842,15 +25386,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -20877,7 +25412,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20934,7 +25469,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21161,6 +25696,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -21256,16 +25852,124 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor" + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "performanceEvaluationRatingLevelDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMPerformanceEvaluationRatingLevel", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor" + } + } + }, + "description": "The JSON representation of the PerformanceEvaluationRatingLevel resource to be created or updated.", + "required": true, + "x-bodyName": "PerformanceEvaluationRatingLevel" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "performanceEvaluationRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/performanceEvaluationRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMPerformanceEvaluationRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -21277,38 +25981,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "performanceEvaluationRatingLevelDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMPerformanceEvaluationRatingLevel", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/performanceEvaluationRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMPerformanceEvaluationRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the PerformanceEvaluationRatingLevel resource to be created or updated.", - "required": true, - "x-bodyName": "PerformanceEvaluationRatingLevel" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -21319,20 +26039,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "performanceEvaluationRatingLevelDescriptors" ] @@ -21375,7 +26089,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21407,15 +26121,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -21442,7 +26147,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21499,7 +26204,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22289,6 +26994,98 @@ "lastSurname" ], "type": "object" + }, + "Tpdm_PerformanceEvaluationRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_PerformanceEvaluationRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationPeriodDescriptor", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_PerformanceEvaluationRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -22456,22 +27253,134 @@ } }, { - "description": "The rating level achieved based upon the rating or score.", - "in": "query", - "name": "performanceEvaluationRatingLevelDescriptor", - "schema": { - "maxLength": 306, - "type": "string" - } + "description": "The rating level achieved based upon the rating or score.", + "in": "query", + "name": "performanceEvaluationRatingLevelDescriptor", + "schema": { + "maxLength": 306, + "type": "string" + } + }, + { + "description": "The month, day, and year on which the performance evaluation was scheduled.", + "in": "query", + "name": "scheduleDate", + "schema": { + "format": "date", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "performanceEvaluationRatings" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMPerformanceEvaluationRating", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating" + } + } + }, + "description": "The JSON representation of the PerformanceEvaluationRating resource to be created or updated.", + "required": true, + "x-bodyName": "PerformanceEvaluationRating" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "performanceEvaluationRatings" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/performanceEvaluationRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMPerformanceEvaluationRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "The month, day, and year on which the performance evaluation was scheduled.", - "in": "query", - "name": "scheduleDate", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -22480,16 +27389,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating" + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -22501,38 +27407,55 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "performanceEvaluationRatings" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMPerformanceEvaluationRating", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/performanceEvaluationRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMPerformanceEvaluationRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the PerformanceEvaluationRating resource to be created or updated.", - "required": true, - "x-bodyName": "PerformanceEvaluationRating" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -22543,20 +27466,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "performanceEvaluationRatings" ] @@ -22600,7 +27517,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22632,15 +27549,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -22667,7 +27575,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22724,7 +27632,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23023,6 +27931,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_PerformanceEvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_PerformanceEvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_PerformanceEvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -23084,32 +28053,143 @@ } }, { - "description": "The end date of the period when the descriptor is in effect.", - "in": "query", - "name": "effectiveEndDate", - "schema": { - "format": "date", - "type": "string" - } + "description": "The end date of the period when the descriptor is in effect.", + "in": "query", + "name": "effectiveEndDate", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", + "in": "query", + "name": "namespace", + "schema": { + "maxLength": 255, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "performanceEvaluationTypeDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMPerformanceEvaluationType", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor" + } + } + }, + "description": "The JSON representation of the PerformanceEvaluationType resource to be created or updated.", + "required": true, + "x-bodyName": "PerformanceEvaluationType" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "performanceEvaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/performanceEvaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMPerformanceEvaluationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", - "in": "query", - "name": "namespace", - "schema": { - "maxLength": 255, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "$ref": "#/components/parameters/limit" }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -23118,16 +28198,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor" + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -23139,38 +28216,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "performanceEvaluationTypeDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMPerformanceEvaluationType", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/performanceEvaluationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMPerformanceEvaluationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the PerformanceEvaluationType resource to be created or updated.", - "required": true, - "x-bodyName": "PerformanceEvaluationType" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -23181,20 +28274,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "performanceEvaluationTypeDescriptors" ] @@ -23237,7 +28324,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23269,15 +28356,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -23304,7 +28382,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23361,7 +28439,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23924,6 +29002,88 @@ "termDescriptor" ], "type": "object" + }, + "Tpdm_PerformanceEvaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_PerformanceEvaluation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationPeriodDescriptor", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_PerformanceEvaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -24063,7 +29223,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24085,16 +29245,142 @@ } } }, - "description": "The JSON representation of the PerformanceEvaluation resource to be created or updated.", - "required": true, - "x-bodyName": "PerformanceEvaluation" - }, + "description": "The JSON representation of the PerformanceEvaluation resource to be created or updated.", + "required": true, + "x-bodyName": "PerformanceEvaluation" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "performanceEvaluations" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/performanceEvaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMPerformanceEvaluationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceEvaluations" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/performanceEvaluations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMPerformanceEvaluationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -24105,20 +29391,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "performanceEvaluations" ] @@ -24162,7 +29442,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24194,15 +29474,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -24229,7 +29500,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24286,7 +29557,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24762,6 +30033,111 @@ "rubricRating" ], "type": "object" + }, + "Tpdm_RubricDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_RubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_RubricDimension_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "rubricRating": { + "format": "int32", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "rubricRating", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_RubricDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_RubricDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_RubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -24899,31 +30275,143 @@ "x-Ed-Fi-isIdentity": true }, { - "description": "The criterion description for the rubric dimension.", - "in": "query", - "name": "criterionDescription", - "schema": { - "maxLength": 1024, - "type": "string" - } + "description": "The criterion description for the rubric dimension.", + "in": "query", + "name": "criterionDescription", + "schema": { + "maxLength": 1024, + "type": "string" + } + }, + { + "description": "The order for the rubric dimension.", + "in": "query", + "name": "dimensionOrder", + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "description": "The rating level achieved for the rubric dimension.", + "in": "query", + "name": "rubricRatingLevelDescriptor", + "schema": { + "maxLength": 306, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_RubricDimension" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "rubricDimensions" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMRubricDimension", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_RubricDimension" + } + } + }, + "description": "The JSON representation of the RubricDimension resource to be created or updated.", + "required": true, + "x-bodyName": "RubricDimension" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "rubricDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/rubricDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMRubricDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" }, { - "description": "The order for the rubric dimension.", - "in": "query", - "name": "dimensionOrder", - "schema": { - "format": "int32", - "type": "integer" - } + "$ref": "#/components/parameters/offset" }, { - "description": "The rating level achieved for the rubric dimension.", - "in": "query", - "name": "rubricRatingLevelDescriptor", - "schema": { - "maxLength": 306, - "type": "string" - } + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -24932,16 +30420,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_RubricDimension" + "$ref": "#/components/schemas/Tpdm_RubricDimension_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -24953,38 +30438,55 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "rubricDimensions" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMRubricDimension", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_RubricDimension" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/rubricDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMRubricDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the RubricDimension resource to be created or updated.", - "required": true, - "x-bodyName": "RubricDimension" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_RubricDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -24995,20 +30497,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "rubricDimensions" ] @@ -25052,7 +30548,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25084,15 +30580,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -25119,7 +30606,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25176,7 +30663,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25449,6 +30936,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_RubricRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_RubricRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_RubricRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -25519,23 +31067,134 @@ } }, { - "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", - "in": "query", - "name": "namespace", - "schema": { - "maxLength": 255, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", + "in": "query", + "name": "namespace", + "schema": { + "maxLength": 255, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "rubricRatingLevelDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMRubricRatingLevel", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor" + } + } + }, + "description": "The JSON representation of the RubricRatingLevel resource to be created or updated.", + "required": true, + "x-bodyName": "RubricRatingLevel" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "rubricRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/rubricRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMRubricRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -25544,16 +31203,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor" + "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -25565,38 +31221,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "rubricRatingLevelDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMRubricRatingLevel", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/rubricRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMRubricRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the RubricRatingLevel resource to be created or updated.", - "required": true, - "x-bodyName": "RubricRatingLevel" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -25607,20 +31279,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "rubricRatingLevelDescriptors" ] @@ -25663,7 +31329,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25695,15 +31361,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -25730,7 +31387,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25787,7 +31444,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26211,6 +31868,83 @@ "surveyResponseIdentifier" ], "type": "object" + }, + "Tpdm_SurveyResponsePersonTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_SurveyResponsePersonTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "namespace", + "personId", + "sourceSystemDescriptor", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "Tpdm_SurveyResponsePersonTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -26285,14 +32019,125 @@ "x-Ed-Fi-isIdentity": true }, { - "description": "The identifier of the survey typically from the survey application.", - "in": "query", - "name": "surveyResponseIdentifier", - "schema": { - "maxLength": 60, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "description": "The identifier of the survey typically from the survey application.", + "in": "query", + "name": "surveyResponseIdentifier", + "schema": { + "maxLength": 60, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "surveyResponsePersonTargetAssociations" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMSurveyResponsePersonTargetAssociation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation" + } + } + }, + "description": "The JSON representation of the SurveyResponsePersonTargetAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "SurveyResponsePersonTargetAssociation" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "surveyResponsePersonTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/surveyResponsePersonTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMSurveyResponsePersonTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -26301,16 +32146,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation" + "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -26322,38 +32164,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "surveyResponsePersonTargetAssociations" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMSurveyResponsePersonTargetAssociation", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/surveyResponsePersonTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMSurveyResponsePersonTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the SurveyResponsePersonTargetAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "SurveyResponsePersonTargetAssociation" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -26364,20 +32222,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "surveyResponsePersonTargetAssociations" ] @@ -26420,7 +32272,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26452,15 +32304,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -26487,7 +32330,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -26544,7 +32387,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27003,6 +32846,88 @@ "surveySectionTitle" ], "type": "object" + }, + "Tpdm_SurveySectionResponsePersonTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_SurveySectionResponsePersonTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_SurveySectionResponsePersonTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "personId", + "sourceSystemDescriptor", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "Tpdm_SurveySectionResponsePersonTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_SurveySectionResponsePersonTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_SurveySectionResponsePersonTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -27124,7 +33049,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27167,7 +33092,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27187,6 +33112,124 @@ "x-Ed-Fi-domains": [ ] }, + "/tpdm/surveySectionResponsePersonTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMSurveySectionResponsePersonTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_SurveySectionResponsePersonTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponsePersonTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/surveySectionResponsePersonTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMSurveySectionResponsePersonTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_SurveySectionResponsePersonTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponsePersonTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/tpdm/surveySectionResponsePersonTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -27222,7 +33265,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27254,15 +33297,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -27289,7 +33323,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27346,7 +33380,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" diff --git a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-5.2-api-schema-authoritative.json b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-5.2-api-schema-authoritative.json index 83e5b5dcd..a3844a10b 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-5.2-api-schema-authoritative.json +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-5.2-api-schema-authoritative.json @@ -976,6 +976,66 @@ ], "isExtensionProject": false, "openApiBaseDocuments": { + "changeQueries": { + "components": { + "parameters": { + }, + "responses": { + }, + "schemas": { + } + }, + "info": { + "contact": { + "url": "https://www.ed-fi.org/what-is-ed-fi/contact/" + }, + "description": "The Ed-Fi DMS API enables applications to read and write education data stored in an Ed-Fi DMS through a secure REST interface. \n***\n > *Note: Consumers of DMS information should sanitize all data for display and storage. DMS provides reasonable safeguards against cross-site scripting attacks and other malicious content, but the platform does not and cannot guarantee that the data it contains is free of all potentially harmful content.* \n***\n", + "title": "Ed-Fi Data Management Service API", + "version": "1" + }, + "openapi": "3.0.0", + "paths": { + "/availableChangeVersions": { + "get": { + "operationId": "getAvailableChangeVersions", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "newestChangeVersion": { + "format": "int64", + "type": "integer" + }, + "oldestChangeVersion": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "oldestChangeVersion", + "newestChangeVersion" + ], + "type": "object" + } + } + }, + "description": "The available change version range was successfully retrieved." + } + }, + "summary": "Retrieves the available change version range." + } + } + }, + "servers": [ + { + "url": "" + } + ], + "tags": [ + ] + }, "descriptors": { "components": { "parameters": { @@ -1001,6 +1061,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1010,6 +1071,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1124,9 +1186,6 @@ "NotFound": { "description": "The resource could not be found." }, - "NotFoundUseSnapshot": { - "description": "The resource could not be found. If Use-Snapshot header is set to true, this response can indicate the snapshot may have been removed." - }, "NotModified": { "description": "The resource's current server-side ETag value matched the If-None-Match header value supplied with the request indicating the resource has not been modified." }, @@ -1187,6 +1246,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1196,6 +1256,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1310,9 +1371,6 @@ "NotFound": { "description": "The resource could not be found." }, - "NotFoundUseSnapshot": { - "description": "The resource could not be found. If Use-Snapshot header is set to true, this response can indicate the snapshot may have been removed." - }, "NotModified": { "description": "The resource's current server-side ETag value matched the If-None-Match header value supplied with the request indicating the resource has not been modified." }, @@ -1857,6 +1915,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AbsenceEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -1973,7 +2092,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2016,7 +2135,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2036,6 +2155,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/absenceEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAbsenceEventCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "absenceEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/absenceEventCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAbsenceEventCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "absenceEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/absenceEventCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -2071,7 +2308,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2103,15 +2340,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -2138,7 +2366,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2195,7 +2423,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2420,6 +2648,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AcademicHonorCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -2536,7 +2825,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2579,7 +2868,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2599,27 +2888,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/academicHonorCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAcademicHonorCategoriesById", + "/ed-fi/academicHonorCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicHonorCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2633,48 +2935,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "academicHonorCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/academicHonorCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAcademicHonorCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicHonorCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -2682,14 +2973,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2701,20 +2992,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "academicHonorCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAcademicHonorCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/academicHonorCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAcademicHonorCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -2729,18 +3024,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AcademicHonorCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AcademicHonorCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -2758,7 +3041,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "academicHonorCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAcademicHonorCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "academicHonorCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAcademicHonorCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AcademicHonorCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AcademicHonorCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2983,6 +3381,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AcademicSubjectDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AcademicSubjectDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AcademicSubjectDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3099,7 +3558,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3142,7 +3601,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3162,27 +3621,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/academicSubjectDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAcademicSubjectsById", + "/ed-fi/academicSubjectDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicSubjectsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3196,48 +3668,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "academicSubjectDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/academicSubjectDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAcademicSubjectsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicSubjectsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -3245,14 +3706,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3264,20 +3725,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "academicSubjectDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAcademicSubject", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/academicSubjectDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAcademicSubjectsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -3292,18 +3757,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" - } - } - }, - "description": "The JSON representation of the AcademicSubject resource to be created or updated.", - "required": true, - "x-bodyName": "AcademicSubject" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -3321,7 +3774,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "academicSubjectDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAcademicSubjectsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "academicSubjectDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAcademicSubject", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" + } + } + }, + "description": "The JSON representation of the AcademicSubject resource to be created or updated.", + "required": true, + "x-bodyName": "AcademicSubject" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3609,6 +4177,68 @@ "weekIdentifier" ], "type": "object" + }, + "EdFi_AcademicWeek_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AcademicWeek_TrackedChangeKey": { + "properties": { + "schoolId": { + "format": "int64", + "type": "integer" + }, + "weekIdentifier": { + "maxLength": 80, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "schoolId", + "weekIdentifier" + ], + "type": "object" + }, + "EdFi_AcademicWeek_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3717,7 +4347,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3760,7 +4390,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3781,27 +4411,40 @@ "SchoolCalendar" ] }, - "/ed-fi/academicWeeks/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAcademicWeeksById", + "/ed-fi/academicWeeks/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicWeeksDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3815,48 +4458,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "academicWeeks" ] }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/academicWeeks/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAcademicWeeksById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicWeeksKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -3864,14 +4497,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AcademicWeek" + "items": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3883,20 +4516,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "academicWeeks" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAcademicWeek", + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/academicWeeks/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAcademicWeeksById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -3911,18 +4549,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AcademicWeek" - } - } - }, - "description": "The JSON representation of the AcademicWeek resource to be created or updated.", - "required": true, - "x-bodyName": "AcademicWeek" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -3940,7 +4566,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "academicWeeks" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAcademicWeeksById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicWeek" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "academicWeeks" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAcademicWeek", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicWeek" + } + } + }, + "description": "The JSON representation of the AcademicWeek resource to be created or updated.", + "required": true, + "x-bodyName": "AcademicWeek" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4163,6 +4904,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AccommodationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccommodationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AccommodationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -4279,7 +5081,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4322,7 +5124,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4342,27 +5144,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/accommodationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAccommodationsById", + "/ed-fi/accommodationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccommodationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4376,48 +5191,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "accommodationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/accommodationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAccommodationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccommodationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -4425,14 +5229,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AccommodationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4444,20 +5248,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "accommodationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAccommodation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/accommodationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAccommodationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -4472,18 +5280,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AccommodationDescriptor" - } - } - }, - "description": "The JSON representation of the Accommodation resource to be created or updated.", - "required": true, - "x-bodyName": "Accommodation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -4501,7 +5297,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "accommodationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAccommodationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "accommodationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAccommodation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor" + } + } + }, + "description": "The JSON representation of the Accommodation resource to be created or updated.", + "required": true, + "x-bodyName": "Accommodation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4726,6 +5637,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AccountTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccountTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AccountTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -4842,7 +5814,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4885,7 +5857,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4905,27 +5877,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/accountTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAccountTypesById", + "/ed-fi/accountTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccountTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4939,48 +5924,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "accountTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/accountTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAccountTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccountTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -4988,14 +5962,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -5007,20 +5981,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "accountTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAccountType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/accountTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAccountTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -5035,18 +6013,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor" - } - } - }, - "description": "The JSON representation of the AccountType resource to be created or updated.", - "required": true, - "x-bodyName": "AccountType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -5064,7 +6030,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "accountTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAccountTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "accountTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAccountType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor" + } + } + }, + "description": "The JSON representation of the AccountType resource to be created or updated.", + "required": true, + "x-bodyName": "AccountType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5410,6 +6491,72 @@ "schoolYear" ], "type": "object" + }, + "EdFi_AccountabilityRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccountabilityRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "ratingTitle": { + "maxLength": 60, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "educationOrganizationId", + "ratingTitle", + "schoolYear" + ], + "type": "object" + }, + "EdFi_AccountabilityRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -5536,7 +6683,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5579,7 +6726,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5601,27 +6748,40 @@ "Enrollment" ] }, - "/ed-fi/accountabilityRatings/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAccountabilityRatingsById", + "/ed-fi/accountabilityRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccountabilityRatingsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -5635,48 +6795,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "accountabilityRatings" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment" + ] + }, + "/ed-fi/accountabilityRatings/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAccountabilityRatingsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccountabilityRatingsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -5684,14 +6835,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AccountabilityRating" + "items": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -5703,20 +6854,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "accountabilityRatings" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAccountabilityRating", + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment" + ] + }, + "/ed-fi/accountabilityRatings/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAccountabilityRatingsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -5731,18 +6888,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AccountabilityRating" - } - } - }, - "description": "The JSON representation of the AccountabilityRating resource to be created or updated.", - "required": true, - "x-bodyName": "AccountabilityRating" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -5760,7 +6905,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "accountabilityRatings" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAccountabilityRatingsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "accountabilityRatings" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAccountabilityRating", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating" + } + } + }, + "description": "The JSON representation of the AccountabilityRating resource to be created or updated.", + "required": true, + "x-bodyName": "AccountabilityRating" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5996,6 +7256,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AchievementCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AchievementCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AchievementCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -6112,7 +7433,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6155,7 +7476,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6175,27 +7496,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/achievementCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAchievementCategoriesById", + "/ed-fi/achievementCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAchievementCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6209,48 +7543,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "achievementCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/achievementCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAchievementCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAchievementCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -6258,14 +7581,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6277,20 +7600,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "achievementCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAchievementCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/achievementCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAchievementCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -6305,18 +7632,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AchievementCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AchievementCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -6334,7 +7649,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "achievementCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAchievementCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "achievementCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAchievementCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AchievementCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AchievementCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6559,6 +7989,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AdditionalCreditTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -6675,7 +8166,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6718,7 +8209,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6738,27 +8229,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/additionalCreditTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAdditionalCreditTypesById", + "/ed-fi/additionalCreditTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAdditionalCreditTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6772,48 +8276,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "additionalCreditTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/additionalCreditTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAdditionalCreditTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAdditionalCreditTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -6821,14 +8314,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6840,20 +8333,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "additionalCreditTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAdditionalCreditType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/additionalCreditTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAdditionalCreditTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -6868,18 +8365,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor" - } - } - }, - "description": "The JSON representation of the AdditionalCreditType resource to be created or updated.", - "required": true, - "x-bodyName": "AdditionalCreditType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -6897,7 +8382,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "additionalCreditTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAdditionalCreditTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "additionalCreditTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAdditionalCreditType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor" + } + } + }, + "description": "The JSON representation of the AdditionalCreditType resource to be created or updated.", + "required": true, + "x-bodyName": "AdditionalCreditType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7122,6 +8722,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AddressTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AddressTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AddressTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -7238,7 +8899,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7281,7 +8942,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7301,27 +8962,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/addressTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAddressTypesById", + "/ed-fi/addressTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAddressTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7335,48 +9009,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "addressTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/addressTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAddressTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAddressTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -7384,14 +9047,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7403,20 +9066,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "addressTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAddressType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/addressTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAddressTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -7431,18 +9098,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor" - } - } - }, - "description": "The JSON representation of the AddressType resource to be created or updated.", - "required": true, - "x-bodyName": "AddressType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -7460,7 +9115,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "addressTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAddressTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "addressTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAddressType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor" + } + } + }, + "description": "The JSON representation of the AddressType resource to be created or updated.", + "required": true, + "x-bodyName": "AddressType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7685,6 +9455,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AdministrationEnvironmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -7801,7 +9632,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7844,7 +9675,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7864,27 +9695,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/administrationEnvironmentDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAdministrationEnvironmentsById", + "/ed-fi/administrationEnvironmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrationEnvironmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7898,48 +9742,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "administrationEnvironmentDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/administrationEnvironmentDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAdministrationEnvironmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrationEnvironmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -7947,14 +9780,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7966,20 +9799,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "administrationEnvironmentDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAdministrationEnvironment", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/administrationEnvironmentDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAdministrationEnvironmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -7994,18 +9831,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor" - } - } - }, - "description": "The JSON representation of the AdministrationEnvironment resource to be created or updated.", - "required": true, - "x-bodyName": "AdministrationEnvironment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -8023,7 +9848,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "administrationEnvironmentDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAdministrationEnvironmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "administrationEnvironmentDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAdministrationEnvironment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor" + } + } + }, + "description": "The JSON representation of the AdministrationEnvironment resource to be created or updated.", + "required": true, + "x-bodyName": "AdministrationEnvironment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8248,6 +10188,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AdministrativeFundingControlDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -8364,7 +10365,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8407,7 +10408,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8427,27 +10428,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/administrativeFundingControlDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAdministrativeFundingControlsById", + "/ed-fi/administrativeFundingControlDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrativeFundingControlsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -8461,48 +10475,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "administrativeFundingControlDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/administrativeFundingControlDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAdministrativeFundingControlsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrativeFundingControlsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -8510,14 +10513,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -8529,20 +10532,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "administrativeFundingControlDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAdministrativeFundingControl", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/administrativeFundingControlDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAdministrativeFundingControlsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -8557,18 +10564,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor" - } - } - }, - "description": "The JSON representation of the AdministrativeFundingControl resource to be created or updated.", - "required": true, - "x-bodyName": "AdministrativeFundingControl" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -8586,7 +10581,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "administrativeFundingControlDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAdministrativeFundingControlsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "administrativeFundingControlDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAdministrativeFundingControl", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor" + } + } + }, + "description": "The JSON representation of the AdministrativeFundingControl resource to be created or updated.", + "required": true, + "x-bodyName": "AdministrativeFundingControl" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8811,6 +10921,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AncestryEthnicOriginDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -8927,7 +11098,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8970,7 +11141,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8990,27 +11161,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/ancestryEthnicOriginDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAncestryEthnicOriginsById", + "/ed-fi/ancestryEthnicOriginDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAncestryEthnicOriginsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -9024,48 +11208,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "ancestryEthnicOriginDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ancestryEthnicOriginDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAncestryEthnicOriginsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAncestryEthnicOriginsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -9073,14 +11246,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -9092,20 +11265,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "ancestryEthnicOriginDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAncestryEthnicOrigin", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ancestryEthnicOriginDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAncestryEthnicOriginsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -9120,18 +11297,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor" - } - } - }, - "description": "The JSON representation of the AncestryEthnicOrigin resource to be created or updated.", - "required": true, - "x-bodyName": "AncestryEthnicOrigin" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -9149,7 +11314,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "ancestryEthnicOriginDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAncestryEthnicOriginsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "ancestryEthnicOriginDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAncestryEthnicOrigin", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor" + } + } + }, + "description": "The JSON representation of the AncestryEthnicOrigin resource to be created or updated.", + "required": true, + "x-bodyName": "AncestryEthnicOrigin" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9598,6 +11878,83 @@ "participatingEducationOrganizationId" ], "type": "object" + }, + "EdFi_AssessmentAdministrationParticipation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentAdministrationParticipation_TrackedChangeKey": { + "properties": { + "administrationIdentifier": { + "maxLength": 255, + "type": "string" + }, + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "assigningEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "participatingEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "administrationIdentifier", + "assessmentIdentifier", + "assigningEducationOrganizationId", + "namespace", + "participatingEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_AssessmentAdministrationParticipation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -9709,7 +12066,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9752,7 +12109,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9773,27 +12130,40 @@ "AssessmentRegistration" ] }, - "/ed-fi/assessmentAdministrationParticipations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentAdministrationParticipationsById", + "/ed-fi/assessmentAdministrationParticipations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentAdministrationParticipationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -9807,48 +12177,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentAdministrationParticipations" ] }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/assessmentAdministrationParticipations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentAdministrationParticipationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentAdministrationParticipationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -9856,14 +12216,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -9875,20 +12235,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentAdministrationParticipations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentAdministrationParticipation", + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/assessmentAdministrationParticipations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentAdministrationParticipationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -9903,18 +12268,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation" - } - } - }, - "description": "The JSON representation of the AssessmentAdministrationParticipation resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentAdministrationParticipation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -9932,7 +12285,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentAdministrationParticipations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentAdministrationParticipationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentAdministrationParticipations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentAdministrationParticipation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation" + } + } + }, + "description": "The JSON representation of the AssessmentAdministrationParticipation resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentAdministrationParticipation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10389,6 +12857,78 @@ "assigningEducationOrganizationId" ], "type": "object" + }, + "EdFi_AssessmentAdministration_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentAdministration_TrackedChangeKey": { + "properties": { + "administrationIdentifier": { + "maxLength": 255, + "type": "string" + }, + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "assigningEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "administrationIdentifier", + "assessmentIdentifier", + "assigningEducationOrganizationId", + "namespace" + ], + "type": "object" + }, + "EdFi_AssessmentAdministration_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -10490,7 +13030,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10533,7 +13073,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10554,27 +13094,40 @@ "AssessmentRegistration" ] }, - "/ed-fi/assessmentAdministrations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentAdministrationsById", + "/ed-fi/assessmentAdministrations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentAdministrationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -10588,48 +13141,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentAdministrations" ] }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/assessmentAdministrations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentAdministrationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentAdministrationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -10637,14 +13180,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentAdministration" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -10656,20 +13199,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentAdministrations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentAdministration", + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/assessmentAdministrations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentAdministrationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -10684,18 +13232,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentAdministration" - } - } - }, - "description": "The JSON representation of the AssessmentAdministration resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentAdministration" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -10713,7 +13249,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentAdministrations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentAdministrationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentAdministrations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentAdministration", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration" + } + } + }, + "description": "The JSON representation of the AssessmentAdministration resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentAdministration" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -11052,6 +13703,73 @@ "assessmentBatteryPartName" ], "type": "object" + }, + "EdFi_AssessmentBatteryPart_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentBatteryPart_TrackedChangeKey": { + "properties": { + "assessmentBatteryPartName": { + "maxLength": 65, + "type": "string" + }, + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentBatteryPartName", + "assessmentIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_AssessmentBatteryPart_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -11143,7 +13861,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -11186,7 +13904,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -11207,27 +13925,40 @@ "AssessmentRegistration" ] }, - "/ed-fi/assessmentBatteryParts/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentBatteryPartsById", + "/ed-fi/assessmentBatteryParts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentBatteryPartsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -11241,48 +13972,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentBatteryParts" ] }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/assessmentBatteryParts/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentBatteryPartsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentBatteryPartsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -11290,14 +14011,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -11309,20 +14030,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentBatteryParts" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentBatteryPart", + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/assessmentBatteryParts/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentBatteryPartsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -11337,18 +14063,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart" - } - } - }, - "description": "The JSON representation of the AssessmentBatteryPart resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentBatteryPart" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -11366,7 +14080,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentBatteryParts" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentBatteryPartsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentBatteryParts" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentBatteryPart", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart" + } + } + }, + "description": "The JSON representation of the AssessmentBatteryPart resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentBatteryPart" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -11575,6 +14404,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -11691,7 +14581,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -11734,7 +14624,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -11754,27 +14644,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentCategoriesById", + "/ed-fi/assessmentCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -11788,48 +14691,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -11837,14 +14729,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -11856,20 +14748,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -11884,18 +14780,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -11913,7 +14797,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -12138,6 +15137,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -12254,7 +15314,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -12297,7 +15357,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -12317,27 +15377,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentIdentificationSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentIdentificationSystemsById", + "/ed-fi/assessmentIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentIdentificationSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -12351,48 +15424,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentIdentificationSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentIdentificationSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentIdentificationSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentIdentificationSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -12400,14 +15462,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -12419,20 +15481,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentIdentificationSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentIdentificationSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentIdentificationSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentIdentificationSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -12447,18 +15513,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentIdentificationSystem resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentIdentificationSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -12476,7 +15530,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentIdentificationSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentIdentificationSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentIdentificationSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentIdentificationSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentIdentificationSystem resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentIdentificationSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -12701,6 +15870,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentItemCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -12817,7 +16047,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -12860,7 +16090,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -12880,27 +16110,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentItemCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentItemCategoriesById", + "/ed-fi/assessmentItemCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -12914,48 +16157,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentItemCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentItemCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentItemCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -12963,14 +16195,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -12982,20 +16214,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentItemCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentItemCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentItemCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentItemCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -13010,18 +16246,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentItemCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentItemCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -13039,7 +16263,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentItemCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentItemCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentItemCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentItemCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentItemCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentItemCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -13264,6 +16603,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentItemResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentItemResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentItemResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -13380,7 +16780,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -13423,7 +16823,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -13443,27 +16843,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentItemResultDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentItemResultsById", + "/ed-fi/assessmentItemResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemResultsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -13477,48 +16890,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentItemResultDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentItemResultDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentItemResultsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemResultsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -13526,14 +16928,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -13545,20 +16947,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentItemResultDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentItemResult", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentItemResultDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentItemResultsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -13573,18 +16979,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentItemResult resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentItemResult" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -13602,7 +16996,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentItemResultDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentItemResultsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentItemResultDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentItemResult", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentItemResult resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentItemResult" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14117,6 +17626,73 @@ "identificationCode" ], "type": "object" + }, + "EdFi_AssessmentItem_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentItem_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "identificationCode": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "identificationCode", + "namespace" + ], + "type": "object" + }, + "EdFi_AssessmentItem_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -14263,7 +17839,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14306,7 +17882,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14328,27 +17904,40 @@ "AssessmentMetadata" ] }, - "/ed-fi/assessmentItems/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentItemsById", + "/ed-fi/assessmentItems/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -14362,48 +17951,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentItems" ] }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessmentItems/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentItemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -14411,14 +17991,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItem" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -14430,20 +18010,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentItems" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentItem", + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessmentItems/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentItemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -14458,18 +18044,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentItem" - } - } - }, - "description": "The JSON representation of the AssessmentItem resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentItem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -14487,7 +18061,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentItems" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentItemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItem" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentItems" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentItem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentItem" + } + } + }, + "description": "The JSON representation of the AssessmentItem resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentItem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14732,6 +18421,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -14848,7 +18598,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14891,7 +18641,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14911,27 +18661,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentPeriodDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentPeriodsById", + "/ed-fi/assessmentPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentPeriodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -14945,48 +18708,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentPeriodDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentPeriodDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentPeriodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentPeriodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -14994,14 +18746,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -15013,20 +18765,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentPeriodDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentPeriod", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentPeriodDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentPeriodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -15041,18 +18797,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentPeriod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -15070,7 +18814,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentPeriodDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentPeriodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentPeriodDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentPeriod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentPeriod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15295,6 +19154,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentReportingMethodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -15411,7 +19331,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15454,7 +19374,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15474,27 +19394,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assessmentReportingMethodDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentReportingMethodsById", + "/ed-fi/assessmentReportingMethodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentReportingMethodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -15508,48 +19441,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentReportingMethodDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentReportingMethodDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentReportingMethodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentReportingMethodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -15557,14 +19479,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -15576,20 +19498,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentReportingMethodDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentReportingMethod", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assessmentReportingMethodDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentReportingMethodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -15604,18 +19530,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor" - } - } - }, - "description": "The JSON representation of the AssessmentReportingMethod resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentReportingMethod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -15633,7 +19547,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentReportingMethodDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentReportingMethodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentReportingMethodDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentReportingMethod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor" + } + } + }, + "description": "The JSON representation of the AssessmentReportingMethod resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentReportingMethod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16071,6 +20100,73 @@ "scoreRangeId" ], "type": "object" + }, + "EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "scoreRangeId": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "namespace", + "scoreRangeId" + ], + "type": "object" + }, + "EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -16199,7 +20295,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16242,7 +20338,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16263,27 +20359,40 @@ "Assessment" ] }, - "/ed-fi/assessmentScoreRangeLearningStandards/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentScoreRangeLearningStandardsById", + "/ed-fi/assessmentScoreRangeLearningStandards/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentScoreRangeLearningStandardsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -16297,48 +20406,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessmentScoreRangeLearningStandards" ] }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, + "/ed-fi/assessmentScoreRangeLearningStandards/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentScoreRangeLearningStandardsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentScoreRangeLearningStandardsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -16346,14 +20445,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard" + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -16365,20 +20464,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessmentScoreRangeLearningStandards" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessmentScoreRangeLearningStandard", + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, + "/ed-fi/assessmentScoreRangeLearningStandards/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentScoreRangeLearningStandardsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -16393,18 +20497,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard" - } - } - }, - "description": "The JSON representation of the AssessmentScoreRangeLearningStandard resource to be created or updated.", - "required": true, - "x-bodyName": "AssessmentScoreRangeLearningStandard" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -16422,7 +20514,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessmentScoreRangeLearningStandards" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentScoreRangeLearningStandardsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessmentScoreRangeLearningStandards" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessmentScoreRangeLearningStandard", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard" + } + } + }, + "description": "The JSON representation of the AssessmentScoreRangeLearningStandard resource to be created or updated.", + "required": true, + "x-bodyName": "AssessmentScoreRangeLearningStandard" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17964,6 +22171,68 @@ "sectionReference" ], "type": "object" + }, + "EdFi_Assessment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Assessment_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_Assessment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -18135,7 +22404,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18178,7 +22447,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18200,27 +22469,40 @@ "AssessmentMetadata" ] }, - "/ed-fi/assessments/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssessmentsById", + "/ed-fi/assessments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -18234,48 +22516,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assessments" ] }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessments/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssessmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -18283,14 +22556,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Assessment" + "items": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -18302,20 +22575,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assessments" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssessment", + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessments/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssessmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -18330,18 +22609,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Assessment" - } - } - }, - "description": "The JSON representation of the Assessment resource to be created or updated.", - "required": true, - "x-bodyName": "Assessment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -18359,7 +22626,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assessments" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssessmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Assessment" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assessments" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssessment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Assessment" + } + } + }, + "description": "The JSON representation of the Assessment resource to be created or updated.", + "required": true, + "x-bodyName": "Assessment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18631,6 +23013,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssignmentLateStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssignmentLateStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -18747,7 +23190,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18790,7 +23233,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18810,27 +23253,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/assignmentLateStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAssignmentLateStatusesById", + "/ed-fi/assignmentLateStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssignmentLateStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -18844,48 +23300,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "assignmentLateStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assignmentLateStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAssignmentLateStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssignmentLateStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -18893,14 +23338,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -18912,20 +23357,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "assignmentLateStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAssignmentLateStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/assignmentLateStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAssignmentLateStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -18940,18 +23389,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor" - } - } - }, - "description": "The JSON representation of the AssignmentLateStatus resource to be created or updated.", - "required": true, - "x-bodyName": "AssignmentLateStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -18969,7 +23406,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "assignmentLateStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAssignmentLateStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "assignmentLateStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAssignmentLateStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor" + } + } + }, + "description": "The JSON representation of the AssignmentLateStatus resource to be created or updated.", + "required": true, + "x-bodyName": "AssignmentLateStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19194,6 +23746,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AttemptStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AttemptStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AttemptStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -19310,7 +23923,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19353,7 +23966,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19373,27 +23986,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/attemptStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAttemptStatusesById", + "/ed-fi/attemptStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAttemptStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -19407,48 +24033,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "attemptStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/attemptStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAttemptStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAttemptStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -19456,14 +24071,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -19475,20 +24090,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "attemptStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAttemptStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/attemptStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAttemptStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -19503,18 +24122,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor" - } - } - }, - "description": "The JSON representation of the AttemptStatus resource to be created or updated.", - "required": true, - "x-bodyName": "AttemptStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -19532,7 +24139,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "attemptStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAttemptStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "attemptStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAttemptStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor" + } + } + }, + "description": "The JSON representation of the AttemptStatus resource to be created or updated.", + "required": true, + "x-bodyName": "AttemptStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19757,6 +24479,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AttendanceEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -19873,7 +24656,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19916,7 +24699,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19936,27 +24719,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/attendanceEventCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAttendanceEventCategoriesById", + "/ed-fi/attendanceEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAttendanceEventCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -19970,48 +24766,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "attendanceEventCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/attendanceEventCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAttendanceEventCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAttendanceEventCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -20019,14 +24804,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20038,20 +24823,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "attendanceEventCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAttendanceEventCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/attendanceEventCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAttendanceEventCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -20066,18 +24855,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AttendanceEventCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AttendanceEventCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -20095,7 +24872,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "attendanceEventCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAttendanceEventCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "attendanceEventCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAttendanceEventCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AttendanceEventCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AttendanceEventCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20382,6 +25274,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_BalanceSheetDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BalanceSheetDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_BalanceSheetDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -20471,7 +25424,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20514,7 +25467,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20535,27 +25488,40 @@ "Finance" ] }, - "/ed-fi/balanceSheetDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteBalanceSheetDimensionsById", + "/ed-fi/balanceSheetDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBalanceSheetDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20569,48 +25535,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "balanceSheetDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/balanceSheetDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getBalanceSheetDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBalanceSheetDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -20618,14 +25574,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_BalanceSheetDimension" + "items": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20637,20 +25593,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "balanceSheetDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putBalanceSheetDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/balanceSheetDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteBalanceSheetDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -20665,18 +25626,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_BalanceSheetDimension" - } - } - }, - "description": "The JSON representation of the BalanceSheetDimension resource to be created or updated.", - "required": true, - "x-bodyName": "BalanceSheetDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -20694,7 +25643,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "balanceSheetDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getBalanceSheetDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "balanceSheetDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putBalanceSheetDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension" + } + } + }, + "description": "The JSON representation of the BalanceSheetDimension resource to be created or updated.", + "required": true, + "x-bodyName": "BalanceSheetDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20901,6 +25965,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -21017,7 +26142,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21060,7 +26185,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21080,27 +26205,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/barrierToInternetAccessInResidenceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteBarrierToInternetAccessInResidencesById", + "/ed-fi/barrierToInternetAccessInResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBarrierToInternetAccessInResidencesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -21114,48 +26252,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "barrierToInternetAccessInResidenceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/barrierToInternetAccessInResidenceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getBarrierToInternetAccessInResidencesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBarrierToInternetAccessInResidencesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -21163,14 +26290,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -21182,20 +26309,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "barrierToInternetAccessInResidenceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putBarrierToInternetAccessInResidence", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/barrierToInternetAccessInResidenceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteBarrierToInternetAccessInResidencesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -21210,18 +26341,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor" - } - } - }, - "description": "The JSON representation of the BarrierToInternetAccessInResidence resource to be created or updated.", - "required": true, - "x-bodyName": "BarrierToInternetAccessInResidence" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -21239,7 +26358,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "barrierToInternetAccessInResidenceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getBarrierToInternetAccessInResidencesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "barrierToInternetAccessInResidenceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putBarrierToInternetAccessInResidence", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor" + } + } + }, + "description": "The JSON representation of the BarrierToInternetAccessInResidence resource to be created or updated.", + "required": true, + "x-bodyName": "BarrierToInternetAccessInResidence" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21464,6 +26698,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BehaviorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BehaviorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BehaviorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -21580,7 +26875,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21623,7 +26918,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21643,27 +26938,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/behaviorDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteBehaviorsById", + "/ed-fi/behaviorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBehaviorsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -21677,48 +26985,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "behaviorDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/behaviorDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getBehaviorsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBehaviorsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -21726,14 +27023,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_BehaviorDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -21745,20 +27042,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "behaviorDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putBehavior", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/behaviorDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteBehaviorsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -21773,18 +27074,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_BehaviorDescriptor" - } - } - }, - "description": "The JSON representation of the Behavior resource to be created or updated.", - "required": true, - "x-bodyName": "Behavior" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -21802,7 +27091,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "behaviorDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getBehaviorsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "behaviorDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putBehavior", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor" + } + } + }, + "description": "The JSON representation of the Behavior resource to be created or updated.", + "required": true, + "x-bodyName": "Behavior" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22287,6 +27691,67 @@ "schoolId" ], "type": "object" + }, + "EdFi_BellSchedule_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BellSchedule_TrackedChangeKey": { + "properties": { + "bellScheduleName": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "bellScheduleName", + "schoolId" + ], + "type": "object" + }, + "EdFi_BellSchedule_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -22401,7 +27866,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22444,7 +27909,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22465,27 +27930,40 @@ "BellSchedule" ] }, - "/ed-fi/bellSchedules/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteBellSchedulesById", + "/ed-fi/bellSchedules/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBellSchedulesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -22499,48 +27977,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "bellSchedules" ] }, + "x-Ed-Fi-domains": [ + "BellSchedule" + ] + }, + "/ed-fi/bellSchedules/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getBellSchedulesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBellSchedulesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -22548,14 +28016,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_BellSchedule" + "items": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -22567,20 +28035,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "bellSchedules" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putBellSchedule", + "x-Ed-Fi-domains": [ + "BellSchedule" + ] + }, + "/ed-fi/bellSchedules/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteBellSchedulesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -22595,18 +28068,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_BellSchedule" - } - } - }, - "description": "The JSON representation of the BellSchedule resource to be created or updated.", - "required": true, - "x-bodyName": "BellSchedule" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -22624,7 +28085,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "bellSchedules" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getBellSchedulesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BellSchedule" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "bellSchedules" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putBellSchedule", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BellSchedule" + } + } + }, + "description": "The JSON representation of the BellSchedule resource to be created or updated.", + "required": true, + "x-bodyName": "BellSchedule" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22853,6 +28429,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BusRouteDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BusRouteDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BusRouteDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -22969,7 +28606,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23012,7 +28649,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23032,27 +28669,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/busRouteDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteBusRoutesById", + "/ed-fi/busRouteDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBusRoutesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -23066,48 +28716,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "busRouteDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/busRouteDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getBusRoutesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBusRoutesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -23115,14 +28754,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_BusRouteDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -23134,20 +28773,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "busRouteDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putBusRoute", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/busRouteDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteBusRoutesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -23162,18 +28805,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_BusRouteDescriptor" - } - } - }, - "description": "The JSON representation of the BusRoute resource to be created or updated.", - "required": true, - "x-bodyName": "BusRoute" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -23191,7 +28822,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "busRouteDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getBusRoutesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "busRouteDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putBusRoute", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor" + } + } + }, + "description": "The JSON representation of the BusRoute resource to be created or updated.", + "required": true, + "x-bodyName": "BusRoute" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23514,6 +29260,77 @@ "date" ], "type": "object" + }, + "EdFi_CalendarDate_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CalendarDate_TrackedChangeKey": { + "properties": { + "calendarCode": { + "maxLength": 60, + "type": "string" + }, + "date": { + "format": "date", + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "calendarCode", + "date", + "schoolId", + "schoolYear" + ], + "type": "object" + }, + "EdFi_CalendarDate_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -23614,7 +29431,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23657,7 +29474,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23678,27 +29495,40 @@ "SchoolCalendar" ] }, - "/ed-fi/calendarDates/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCalendarDatesById", + "/ed-fi/calendarDates/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarDatesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -23712,48 +29542,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "calendarDates" ] }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendarDates/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCalendarDatesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarDatesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -23761,14 +29581,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CalendarDate" + "items": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -23780,20 +29600,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "calendarDates" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCalendarDate", + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendarDates/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCalendarDatesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -23808,18 +29633,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CalendarDate" - } - } - }, - "description": "The JSON representation of the CalendarDate resource to be created or updated.", - "required": true, - "x-bodyName": "CalendarDate" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -23837,7 +29650,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "calendarDates" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCalendarDatesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarDate" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "calendarDates" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCalendarDate", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarDate" + } + } + }, + "description": "The JSON representation of the CalendarDate resource to be created or updated.", + "required": true, + "x-bodyName": "CalendarDate" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24054,6 +29982,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CalendarEventDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CalendarEventDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CalendarEventDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -24170,7 +30159,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24213,7 +30202,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24233,27 +30222,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/calendarEventDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCalendarEventsById", + "/ed-fi/calendarEventDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -24267,48 +30269,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "calendarEventDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/calendarEventDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCalendarEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -24316,14 +30307,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -24335,20 +30326,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "calendarEventDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCalendarEvent", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/calendarEventDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCalendarEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -24363,18 +30358,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor" - } - } - }, - "description": "The JSON representation of the CalendarEvent resource to be created or updated.", - "required": true, - "x-bodyName": "CalendarEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -24392,7 +30375,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "calendarEventDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCalendarEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "calendarEventDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCalendarEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor" + } + } + }, + "description": "The JSON representation of the CalendarEvent resource to be created or updated.", + "required": true, + "x-bodyName": "CalendarEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24617,6 +30715,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CalendarTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CalendarTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CalendarTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -24733,7 +30892,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24776,7 +30935,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24796,27 +30955,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/calendarTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCalendarTypesById", + "/ed-fi/calendarTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -24830,48 +31002,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "calendarTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/calendarTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCalendarTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -24879,14 +31040,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -24898,20 +31059,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "calendarTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCalendarType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/calendarTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCalendarTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -24926,18 +31091,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CalendarType resource to be created or updated.", - "required": true, - "x-bodyName": "CalendarType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -24955,7 +31108,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "calendarTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCalendarTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "calendarTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCalendarType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CalendarType resource to be created or updated.", + "required": true, + "x-bodyName": "CalendarType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25302,6 +31570,72 @@ "schoolYear" ], "type": "object" + }, + "EdFi_Calendar_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Calendar_TrackedChangeKey": { + "properties": { + "calendarCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "calendarCode", + "schoolId", + "schoolYear" + ], + "type": "object" + }, + "EdFi_Calendar_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -25401,7 +31735,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25444,7 +31778,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25465,27 +31799,40 @@ "SchoolCalendar" ] }, - "/ed-fi/calendars/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCalendarsById", + "/ed-fi/calendars/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -25499,48 +31846,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "calendars" ] }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendars/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCalendarsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -25548,14 +31885,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Calendar" + "items": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -25567,20 +31904,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "calendars" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCalendar", + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendars/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCalendarsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -25595,18 +31937,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Calendar" - } - } - }, - "description": "The JSON representation of the Calendar resource to be created or updated.", - "required": true, - "x-bodyName": "Calendar" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -25624,7 +31954,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "calendars" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCalendarsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Calendar" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "calendars" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCalendar", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Calendar" + } + } + }, + "description": "The JSON representation of the Calendar resource to be created or updated.", + "required": true, + "x-bodyName": "Calendar" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25841,6 +32286,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CareerPathwayDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CareerPathwayDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CareerPathwayDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -25957,7 +32463,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -26000,7 +32506,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26020,27 +32526,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/careerPathwayDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCareerPathwaysById", + "/ed-fi/careerPathwayDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCareerPathwaysDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -26054,48 +32573,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "careerPathwayDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/careerPathwayDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCareerPathwaysById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCareerPathwaysKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -26103,14 +32611,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -26122,20 +32630,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "careerPathwayDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCareerPathway", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/careerPathwayDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCareerPathwaysById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -26150,18 +32662,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor" - } - } - }, - "description": "The JSON representation of the CareerPathway resource to be created or updated.", - "required": true, - "x-bodyName": "CareerPathway" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -26179,7 +32679,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "careerPathwayDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCareerPathwaysById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "careerPathwayDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCareerPathway", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor" + } + } + }, + "description": "The JSON representation of the CareerPathway resource to be created or updated.", + "required": true, + "x-bodyName": "CareerPathway" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26966,6 +33581,72 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ChartOfAccount_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ChartOfAccount_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ChartOfAccount_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -27154,7 +33835,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27197,7 +33878,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27218,27 +33899,40 @@ "Finance" ] }, - "/ed-fi/chartOfAccounts/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteChartOfAccountsById", + "/ed-fi/chartOfAccounts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getChartOfAccountsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -27252,48 +33946,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "chartOfAccounts" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/chartOfAccounts/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getChartOfAccountsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getChartOfAccountsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -27301,14 +33985,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ChartOfAccount" + "items": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -27320,20 +34004,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "chartOfAccounts" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putChartOfAccount", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/chartOfAccounts/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteChartOfAccountsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -27348,18 +34037,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ChartOfAccount" - } - } - }, - "description": "The JSON representation of the ChartOfAccount resource to be created or updated.", - "required": true, - "x-bodyName": "ChartOfAccount" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -27377,7 +34054,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "chartOfAccounts" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getChartOfAccountsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "chartOfAccounts" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putChartOfAccount", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount" + } + } + }, + "description": "The JSON representation of the ChartOfAccount resource to be created or updated.", + "required": true, + "x-bodyName": "ChartOfAccount" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27660,6 +34452,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -27776,7 +34629,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27819,7 +34672,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27839,27 +34692,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/charterApprovalAgencyTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCharterApprovalAgencyTypesById", + "/ed-fi/charterApprovalAgencyTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCharterApprovalAgencyTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -27873,48 +34739,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "charterApprovalAgencyTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/charterApprovalAgencyTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCharterApprovalAgencyTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCharterApprovalAgencyTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -27922,14 +34777,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -27941,20 +34796,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "charterApprovalAgencyTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCharterApprovalAgencyType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/charterApprovalAgencyTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCharterApprovalAgencyTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -27969,18 +34828,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CharterApprovalAgencyType resource to be created or updated.", - "required": true, - "x-bodyName": "CharterApprovalAgencyType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -27998,7 +34845,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "charterApprovalAgencyTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCharterApprovalAgencyTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "charterApprovalAgencyTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCharterApprovalAgencyType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CharterApprovalAgencyType resource to be created or updated.", + "required": true, + "x-bodyName": "CharterApprovalAgencyType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28223,6 +35185,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CharterStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CharterStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CharterStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -28339,7 +35362,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28382,7 +35405,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28402,27 +35425,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/charterStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCharterStatusesById", + "/ed-fi/charterStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCharterStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -28436,48 +35472,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "charterStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/charterStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCharterStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCharterStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -28485,14 +35510,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -28504,20 +35529,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "charterStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCharterStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/charterStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCharterStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -28532,18 +35561,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor" - } - } - }, - "description": "The JSON representation of the CharterStatus resource to be created or updated.", - "required": true, - "x-bodyName": "CharterStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -28561,7 +35578,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "charterStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCharterStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "charterStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCharterStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor" + } + } + }, + "description": "The JSON representation of the CharterStatus resource to be created or updated.", + "required": true, + "x-bodyName": "CharterStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28786,6 +35918,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CitizenshipStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CitizenshipStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CitizenshipStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -28902,7 +36095,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28945,7 +36138,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28965,27 +36158,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/citizenshipStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCitizenshipStatusesById", + "/ed-fi/citizenshipStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCitizenshipStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -28999,48 +36205,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "citizenshipStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/citizenshipStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCitizenshipStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCitizenshipStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -29048,14 +36243,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -29067,20 +36262,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "citizenshipStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCitizenshipStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/citizenshipStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCitizenshipStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -29095,18 +36294,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor" - } - } - }, - "description": "The JSON representation of the CitizenshipStatus resource to be created or updated.", - "required": true, - "x-bodyName": "CitizenshipStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -29124,7 +36311,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "citizenshipStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCitizenshipStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "citizenshipStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCitizenshipStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor" + } + } + }, + "description": "The JSON representation of the CitizenshipStatus resource to be created or updated.", + "required": true, + "x-bodyName": "CitizenshipStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29438,6 +36740,67 @@ "schoolId" ], "type": "object" + }, + "EdFi_ClassPeriod_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ClassPeriod_TrackedChangeKey": { + "properties": { + "classPeriodName": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "classPeriodName", + "schoolId" + ], + "type": "object" + }, + "EdFi_ClassPeriod_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -29526,7 +36889,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29569,7 +36932,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29592,27 +36955,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/classPeriods/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteClassPeriodsById", + "/ed-fi/classPeriods/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getClassPeriodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -29626,48 +37002,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "classPeriods" ] }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/classPeriods/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getClassPeriodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getClassPeriodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -29675,14 +37043,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ClassPeriod" + "items": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -29694,20 +37062,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "classPeriods" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putClassPeriod", + "x-Ed-Fi-domains": [ + "BellSchedule", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/classPeriods/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteClassPeriodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -29722,18 +37097,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ClassPeriod" - } - } - }, - "description": "The JSON representation of the ClassPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "ClassPeriod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -29751,7 +37114,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "classPeriods" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getClassPeriodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ClassPeriod" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "classPeriods" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putClassPeriod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ClassPeriod" + } + } + }, + "description": "The JSON representation of the ClassPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "ClassPeriod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29965,6 +37443,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ClassroomPositionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ClassroomPositionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ClassroomPositionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -30081,7 +37620,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30124,7 +37663,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -30144,27 +37683,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/classroomPositionDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteClassroomPositionsById", + "/ed-fi/classroomPositionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getClassroomPositionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -30178,48 +37730,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "classroomPositionDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/classroomPositionDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getClassroomPositionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getClassroomPositionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -30227,14 +37768,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -30246,20 +37787,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "classroomPositionDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putClassroomPosition", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/classroomPositionDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteClassroomPositionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -30274,18 +37819,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor" - } - } - }, - "description": "The JSON representation of the ClassroomPosition resource to be created or updated.", - "required": true, - "x-bodyName": "ClassroomPosition" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -30303,7 +37836,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "classroomPositionDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getClassroomPositionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "classroomPositionDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putClassroomPosition", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor" + } + } + }, + "description": "The JSON representation of the ClassroomPosition resource to be created or updated.", + "required": true, + "x-bodyName": "ClassroomPosition" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -30528,6 +38176,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CohortScopeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CohortScopeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CohortScopeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -30644,7 +38353,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30687,7 +38396,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -30707,27 +38416,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/cohortScopeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCohortScopesById", + "/ed-fi/cohortScopeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortScopesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -30741,48 +38463,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "cohortScopeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortScopeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCohortScopesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortScopesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -30790,14 +38501,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -30809,20 +38520,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "cohortScopeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCohortScope", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortScopeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCohortScopesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -30837,18 +38552,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor" - } - } - }, - "description": "The JSON representation of the CohortScope resource to be created or updated.", - "required": true, - "x-bodyName": "CohortScope" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -30866,7 +38569,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "cohortScopeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCohortScopesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "cohortScopeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCohortScope", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor" + } + } + }, + "description": "The JSON representation of the CohortScope resource to be created or updated.", + "required": true, + "x-bodyName": "CohortScope" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31091,6 +38909,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CohortTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CohortTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CohortTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -31207,7 +39086,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31250,7 +39129,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31270,27 +39149,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/cohortTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCohortTypesById", + "/ed-fi/cohortTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -31304,48 +39196,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "cohortTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCohortTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -31353,14 +39234,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -31372,20 +39253,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "cohortTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCohortType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCohortTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -31400,18 +39285,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CohortType resource to be created or updated.", - "required": true, - "x-bodyName": "CohortType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -31429,7 +39302,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "cohortTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCohortTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "cohortTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCohortType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CohortType resource to be created or updated.", + "required": true, + "x-bodyName": "CohortType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31654,6 +39642,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CohortYearTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CohortYearTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CohortYearTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -31770,7 +39819,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31813,7 +39862,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31833,27 +39882,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/cohortYearTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCohortYearTypesById", + "/ed-fi/cohortYearTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortYearTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -31867,48 +39929,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "cohortYearTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortYearTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCohortYearTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortYearTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -31916,14 +39967,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -31935,20 +39986,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "cohortYearTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCohortYearType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cohortYearTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCohortYearTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -31963,18 +40018,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CohortYearType resource to be created or updated.", - "required": true, - "x-bodyName": "CohortYearType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -31992,7 +40035,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "cohortYearTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCohortYearTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "cohortYearTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCohortYearType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CohortYearType resource to be created or updated.", + "required": true, + "x-bodyName": "CohortYearType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -32384,6 +40542,67 @@ "educationOrganizationId" ], "type": "object" + }, + "EdFi_Cohort_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Cohort_TrackedChangeKey": { + "properties": { + "cohortIdentifier": { + "maxLength": 36, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "cohortIdentifier", + "educationOrganizationId" + ], + "type": "object" + }, + "EdFi_Cohort_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -32500,7 +40719,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32543,7 +40762,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -32565,27 +40784,40 @@ "StudentCohort" ] }, - "/ed-fi/cohorts/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCohortsById", + "/ed-fi/cohorts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -32599,48 +40831,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "cohorts" ] }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/cohorts/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCohortsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -32648,14 +40871,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Cohort" + "items": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -32667,20 +40890,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "cohorts" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCohort", + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/cohorts/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCohortsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -32695,18 +40924,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Cohort" - } - } - }, - "description": "The JSON representation of the Cohort resource to be created or updated.", - "required": true, - "x-bodyName": "Cohort" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -32724,7 +40941,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "cohorts" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCohortsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Cohort" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "cohorts" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCohort", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Cohort" + } + } + }, + "description": "The JSON representation of the Cohort resource to be created or updated.", + "required": true, + "x-bodyName": "Cohort" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -33716,6 +42048,62 @@ ], "type": "object" }, + "EdFi_CommunityOrganization_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CommunityOrganization_TrackedChangeKey": { + "properties": { + "communityOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "communityOrganizationId" + ], + "type": "object" + }, + "EdFi_CommunityOrganization_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_EducationOrganization_Address": { "properties": { "addressTypeDescriptor": { @@ -34104,7 +42492,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34147,7 +42535,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34168,27 +42556,40 @@ "EducationOrganization" ] }, - "/ed-fi/communityOrganizations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCommunityOrganizationsById", + "/ed-fi/communityOrganizations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityOrganizationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -34202,48 +42603,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "communityOrganizations" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityOrganizations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCommunityOrganizationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityOrganizationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -34251,14 +42642,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CommunityOrganization" + "items": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -34270,20 +42661,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "communityOrganizations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCommunityOrganization", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityOrganizations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCommunityOrganizationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -34298,18 +42694,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CommunityOrganization" - } - } - }, - "description": "The JSON representation of the CommunityOrganization resource to be created or updated.", - "required": true, - "x-bodyName": "CommunityOrganization" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -34327,7 +42711,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "communityOrganizations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCommunityOrganizationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "communityOrganizations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCommunityOrganization", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization" + } + } + }, + "description": "The JSON representation of the CommunityOrganization resource to be created or updated.", + "required": true, + "x-bodyName": "CommunityOrganization" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34746,6 +43245,72 @@ "licensingOrganization" ], "type": "object" + }, + "EdFi_CommunityProviderLicense_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CommunityProviderLicense_TrackedChangeKey": { + "properties": { + "communityProviderId": { + "format": "int64", + "type": "integer" + }, + "licenseIdentifier": { + "maxLength": 36, + "type": "string" + }, + "licensingOrganization": { + "maxLength": 75, + "type": "string" + } + }, + "required": [ + "communityProviderId", + "licenseIdentifier", + "licensingOrganization" + ], + "type": "object" + }, + "EdFi_CommunityProviderLicense_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -34908,7 +43473,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34951,7 +43516,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34972,27 +43537,40 @@ "EducationOrganization" ] }, - "/ed-fi/communityProviderLicenses/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCommunityProviderLicensesById", + "/ed-fi/communityProviderLicenses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProviderLicensesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -35006,48 +43584,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "communityProviderLicenses" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityProviderLicenses/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCommunityProviderLicensesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProviderLicensesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -35055,14 +43623,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CommunityProviderLicense" + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -35074,20 +43642,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "communityProviderLicenses" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCommunityProviderLicense", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityProviderLicenses/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCommunityProviderLicensesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -35102,18 +43675,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CommunityProviderLicense" - } - } - }, - "description": "The JSON representation of the CommunityProviderLicense resource to be created or updated.", - "required": true, - "x-bodyName": "CommunityProviderLicense" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -35131,7 +43692,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "communityProviderLicenses" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCommunityProviderLicensesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "communityProviderLicenses" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCommunityProviderLicense", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense" + } + } + }, + "description": "The JSON representation of the CommunityProviderLicense resource to be created or updated.", + "required": true, + "x-bodyName": "CommunityProviderLicense" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -36280,6 +44956,62 @@ ], "type": "object" }, + "EdFi_CommunityProvider_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CommunityProvider_TrackedChangeKey": { + "properties": { + "communityProviderId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "communityProviderId" + ], + "type": "object" + }, + "EdFi_CommunityProvider_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_EducationOrganization_Address": { "properties": { "addressTypeDescriptor": { @@ -36721,7 +45453,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36764,7 +45496,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -36785,27 +45517,40 @@ "EducationOrganization" ] }, - "/ed-fi/communityProviders/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCommunityProvidersById", + "/ed-fi/communityProviders/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProvidersDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -36819,48 +45564,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "communityProviders" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityProviders/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCommunityProvidersById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProvidersKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -36868,14 +45603,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CommunityProvider" + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -36887,20 +45622,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "communityProviders" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCommunityProvider", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityProviders/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCommunityProvidersById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -36915,18 +45655,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CommunityProvider" - } - } - }, - "description": "The JSON representation of the CommunityProvider resource to be created or updated.", - "required": true, - "x-bodyName": "CommunityProvider" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -36944,7 +45672,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "communityProviders" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCommunityProvidersById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityProvider" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "communityProviders" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCommunityProvider", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CommunityProvider" + } + } + }, + "description": "The JSON representation of the CommunityProvider resource to be created or updated.", + "required": true, + "x-bodyName": "CommunityProvider" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -37214,6 +46057,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CompetencyLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CompetencyLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CompetencyLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -37330,7 +46234,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -37373,7 +46277,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -37393,27 +46297,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/competencyLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCompetencyLevelsById", + "/ed-fi/competencyLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -37427,48 +46344,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "competencyLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/competencyLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCompetencyLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -37476,14 +46382,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -37495,20 +46401,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "competencyLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCompetencyLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/competencyLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCompetencyLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -37523,18 +46433,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor" - } - } - }, - "description": "The JSON representation of the CompetencyLevel resource to be created or updated.", - "required": true, - "x-bodyName": "CompetencyLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -37552,7 +46450,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "competencyLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCompetencyLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "competencyLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCompetencyLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor" + } + } + }, + "description": "The JSON representation of the CompetencyLevel resource to be created or updated.", + "required": true, + "x-bodyName": "CompetencyLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -37861,6 +46874,72 @@ "objectiveGradeLevelDescriptor" ], "type": "object" + }, + "EdFi_CompetencyObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CompetencyObjective_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "objective": { + "maxLength": 60, + "type": "string" + }, + "objectiveGradeLevelDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor" + ], + "type": "object" + }, + "EdFi_CompetencyObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -37978,7 +47057,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38021,7 +47100,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38043,27 +47122,40 @@ "ReportCard" ] }, - "/ed-fi/competencyObjectives/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCompetencyObjectivesById", + "/ed-fi/competencyObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyObjectivesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -38077,48 +47169,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "competencyObjectives" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/competencyObjectives/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCompetencyObjectivesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyObjectivesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -38126,14 +47209,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CompetencyObjective" + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -38145,20 +47228,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "competencyObjectives" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCompetencyObjective", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/competencyObjectives/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCompetencyObjectivesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -38173,18 +47262,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CompetencyObjective" - } - } - }, - "description": "The JSON representation of the CompetencyObjective resource to be created or updated.", - "required": true, - "x-bodyName": "CompetencyObjective" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -38202,7 +47279,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "competencyObjectives" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCompetencyObjectivesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "competencyObjectives" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCompetencyObjective", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective" + } + } + }, + "description": "The JSON representation of the CompetencyObjective resource to be created or updated.", + "required": true, + "x-bodyName": "CompetencyObjective" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38432,6 +47624,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ContactTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContactTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ContactTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -38548,7 +47801,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38591,7 +47844,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38611,27 +47864,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/contactTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteContactTypesById", + "/ed-fi/contactTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContactTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -38645,48 +47911,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "contactTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/contactTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getContactTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContactTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -38694,14 +47949,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -38713,20 +47968,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "contactTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putContactType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/contactTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteContactTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -38741,18 +48000,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ContactType resource to be created or updated.", - "required": true, - "x-bodyName": "ContactType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -38770,7 +48017,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "contactTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getContactTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "contactTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putContactType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContactTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ContactType resource to be created or updated.", + "required": true, + "x-bodyName": "ContactType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -40509,6 +49871,62 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "EdFi_Contact_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Contact_TrackedChangeKey": { + "properties": { + "contactUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "contactUniqueId" + ], + "type": "object" + }, + "EdFi_Contact_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -40707,7 +50125,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -40750,7 +50168,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -40772,27 +50190,40 @@ "Survey" ] }, - "/ed-fi/contacts/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteContactsById", + "/ed-fi/contacts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContactsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -40806,48 +50237,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "contacts" ] }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics", + "Survey" + ] + }, + "/ed-fi/contacts/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getContactsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContactsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -40855,14 +50277,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Contact" + "items": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -40874,20 +50296,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "contacts" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putContact", + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics", + "Survey" + ] + }, + "/ed-fi/contacts/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteContactsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -40902,18 +50330,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Contact" - } - } - }, - "description": "The JSON representation of the Contact resource to be created or updated.", - "required": true, - "x-bodyName": "Contact" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -40931,7 +50347,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "contacts" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getContactsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Contact" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "contacts" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putContact", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Contact" + } + } + }, + "description": "The JSON representation of the Contact resource to be created or updated.", + "required": true, + "x-bodyName": "Contact" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -41220,6 +50751,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ContentClassDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContentClassDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ContentClassDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -41336,7 +50928,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -41379,7 +50971,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -41399,27 +50991,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/contentClassDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteContentClassesById", + "/ed-fi/contentClassDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContentClassesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -41433,48 +51038,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "contentClassDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/contentClassDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getContentClassesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContentClassesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -41482,14 +51076,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ContentClassDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -41501,20 +51095,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "contentClassDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putContentClass", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/contentClassDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteContentClassesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -41529,18 +51127,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ContentClassDescriptor" - } - } - }, - "description": "The JSON representation of the ContentClass resource to be created or updated.", - "required": true, - "x-bodyName": "ContentClass" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -41558,7 +51144,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "contentClassDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getContentClassesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "contentClassDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putContentClass", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor" + } + } + }, + "description": "The JSON representation of the ContentClass resource to be created or updated.", + "required": true, + "x-bodyName": "ContentClass" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -41783,6 +51484,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -41899,7 +51661,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -41942,7 +51704,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -41962,27 +51724,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/continuationOfServicesReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteContinuationOfServicesReasonsById", + "/ed-fi/continuationOfServicesReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContinuationOfServicesReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -41996,48 +51771,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "continuationOfServicesReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/continuationOfServicesReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getContinuationOfServicesReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContinuationOfServicesReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -42045,14 +51809,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -42064,20 +51828,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "continuationOfServicesReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putContinuationOfServicesReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/continuationOfServicesReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteContinuationOfServicesReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -42092,18 +51860,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor" - } - } - }, - "description": "The JSON representation of the ContinuationOfServicesReason resource to be created or updated.", - "required": true, - "x-bodyName": "ContinuationOfServicesReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -42121,7 +51877,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "continuationOfServicesReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getContinuationOfServicesReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "continuationOfServicesReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putContinuationOfServicesReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor" + } + } + }, + "description": "The JSON representation of the ContinuationOfServicesReason resource to be created or updated.", + "required": true, + "x-bodyName": "ContinuationOfServicesReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -42346,6 +52217,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CostRateDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CostRateDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CostRateDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -42462,7 +52394,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -42505,7 +52437,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -42525,27 +52457,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/costRateDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCostRatesById", + "/ed-fi/costRateDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCostRatesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -42559,48 +52504,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "costRateDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/costRateDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCostRatesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCostRatesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -42608,14 +52542,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CostRateDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -42627,20 +52561,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "costRateDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCostRate", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/costRateDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCostRatesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -42655,18 +52593,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CostRateDescriptor" - } - } - }, - "description": "The JSON representation of the CostRate resource to be created or updated.", - "required": true, - "x-bodyName": "CostRate" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -42684,7 +52610,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "costRateDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCostRatesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "costRateDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCostRate", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor" + } + } + }, + "description": "The JSON representation of the CostRate resource to be created or updated.", + "required": true, + "x-bodyName": "CostRate" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -42909,6 +52950,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CountryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CountryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CountryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -43025,7 +53127,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43068,7 +53170,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -43088,27 +53190,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/countryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCountriesById", + "/ed-fi/countryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCountriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -43122,48 +53237,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "countryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/countryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCountriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCountriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -43171,14 +53275,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CountryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -43190,20 +53294,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "countryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCountry", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/countryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCountriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -43218,18 +53326,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CountryDescriptor" - } - } - }, - "description": "The JSON representation of the Country resource to be created or updated.", - "required": true, - "x-bodyName": "Country" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -43247,7 +53343,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "countryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCountriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "countryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCountry", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor" + } + } + }, + "description": "The JSON representation of the Country resource to be created or updated.", + "required": true, + "x-bodyName": "Country" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -43472,6 +53683,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseAttemptResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseAttemptResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseAttemptResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -43588,7 +53860,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43631,7 +53903,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -43651,27 +53923,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseAttemptResultDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseAttemptResultsById", + "/ed-fi/courseAttemptResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseAttemptResultsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -43685,48 +53970,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseAttemptResultDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseAttemptResultDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseAttemptResultsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseAttemptResultsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -43734,14 +54008,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -43753,20 +54027,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseAttemptResultDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseAttemptResult", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseAttemptResultDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseAttemptResultsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -43781,18 +54059,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor" - } - } - }, - "description": "The JSON representation of the CourseAttemptResult resource to be created or updated.", - "required": true, - "x-bodyName": "CourseAttemptResult" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -43810,7 +54076,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseAttemptResultDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseAttemptResultsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseAttemptResultDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseAttemptResult", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor" + } + } + }, + "description": "The JSON representation of the CourseAttemptResult resource to be created or updated.", + "required": true, + "x-bodyName": "CourseAttemptResult" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44035,6 +54416,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseDefinedByDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseDefinedByDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseDefinedByDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -44151,7 +54593,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44194,7 +54636,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44214,27 +54656,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseDefinedByDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseDefinedBiesById", + "/ed-fi/courseDefinedByDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseDefinedBiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -44248,48 +54703,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseDefinedByDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseDefinedByDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseDefinedBiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseDefinedBiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -44297,14 +54741,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -44316,20 +54760,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseDefinedByDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseDefinedBy", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseDefinedByDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseDefinedBiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -44344,18 +54792,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor" - } - } - }, - "description": "The JSON representation of the CourseDefinedBy resource to be created or updated.", - "required": true, - "x-bodyName": "CourseDefinedBy" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -44373,7 +54809,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseDefinedByDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseDefinedBiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseDefinedByDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseDefinedBy", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor" + } + } + }, + "description": "The JSON representation of the CourseDefinedBy resource to be created or updated.", + "required": true, + "x-bodyName": "CourseDefinedBy" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44598,6 +55149,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -44714,7 +55326,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44757,7 +55369,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44777,27 +55389,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseGPAApplicabilityDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseGPAApplicabilitiesById", + "/ed-fi/courseGPAApplicabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseGPAApplicabilitiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -44811,48 +55436,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseGPAApplicabilityDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseGPAApplicabilityDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseGPAApplicabilitiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseGPAApplicabilitiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -44860,14 +55474,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -44879,20 +55493,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseGPAApplicabilityDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseGPAApplicability", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseGPAApplicabilityDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseGPAApplicabilitiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -44907,18 +55525,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor" - } - } - }, - "description": "The JSON representation of the CourseGPAApplicability resource to be created or updated.", - "required": true, - "x-bodyName": "CourseGPAApplicability" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -44936,7 +55542,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseGPAApplicabilityDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseGPAApplicabilitiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseGPAApplicabilityDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseGPAApplicability", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor" + } + } + }, + "description": "The JSON representation of the CourseGPAApplicability resource to be created or updated.", + "required": true, + "x-bodyName": "CourseGPAApplicability" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -45161,6 +55882,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -45277,7 +56059,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -45320,7 +56102,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -45340,27 +56122,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseIdentificationSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseIdentificationSystemsById", + "/ed-fi/courseIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseIdentificationSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -45374,48 +56169,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseIdentificationSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseIdentificationSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseIdentificationSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseIdentificationSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -45423,14 +56207,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -45442,20 +56226,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseIdentificationSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseIdentificationSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseIdentificationSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseIdentificationSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -45470,18 +56258,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor" - } - } - }, - "description": "The JSON representation of the CourseIdentificationSystem resource to be created or updated.", - "required": true, - "x-bodyName": "CourseIdentificationSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -45499,7 +56275,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseIdentificationSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseIdentificationSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseIdentificationSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseIdentificationSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor" + } + } + }, + "description": "The JSON representation of the CourseIdentificationSystem resource to be created or updated.", + "required": true, + "x-bodyName": "CourseIdentificationSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -45724,6 +56615,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -45840,7 +56792,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -45883,7 +56835,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -45903,27 +56855,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseLevelCharacteristicDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseLevelCharacteristicsById", + "/ed-fi/courseLevelCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseLevelCharacteristicsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -45937,48 +56902,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseLevelCharacteristicDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseLevelCharacteristicDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseLevelCharacteristicsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseLevelCharacteristicsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -45986,14 +56940,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -46005,20 +56959,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseLevelCharacteristicDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseLevelCharacteristic", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseLevelCharacteristicDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseLevelCharacteristicsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -46033,18 +56991,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor" - } - } - }, - "description": "The JSON representation of the CourseLevelCharacteristic resource to be created or updated.", - "required": true, - "x-bodyName": "CourseLevelCharacteristic" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -46062,7 +57008,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseLevelCharacteristicDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseLevelCharacteristicsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseLevelCharacteristicDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseLevelCharacteristic", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor" + } + } + }, + "description": "The JSON representation of the CourseLevelCharacteristic resource to be created or updated.", + "required": true, + "x-bodyName": "CourseLevelCharacteristic" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -46623,6 +57684,77 @@ "sessionName" ], "type": "object" + }, + "EdFi_CourseOffering_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseOffering_TrackedChangeKey": { + "properties": { + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName" + ], + "type": "object" + }, + "EdFi_CourseOffering_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -46761,7 +57893,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46804,7 +57936,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -46828,27 +57960,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/courseOfferings/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseOfferingsById", + "/ed-fi/courseOfferings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseOfferingsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -46862,48 +58007,41 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseOfferings" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/courseOfferings/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseOfferingsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseOfferingsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -46911,14 +58049,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseOffering" + "items": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -46930,20 +58068,28 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseOfferings" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseOffering", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/courseOfferings/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseOfferingsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -46958,18 +58104,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseOffering" - } - } - }, - "description": "The JSON representation of the CourseOffering resource to be created or updated.", - "required": true, - "x-bodyName": "CourseOffering" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -46987,7 +58121,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseOfferings" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseOfferingsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseOffering" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseOfferings" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseOffering", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseOffering" + } + } + }, + "description": "The JSON representation of the CourseOffering resource to be created or updated.", + "required": true, + "x-bodyName": "CourseOffering" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -47235,6 +58484,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseRepeatCodeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseRepeatCodeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -47351,7 +58661,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47394,7 +58704,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -47414,27 +58724,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/courseRepeatCodeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseRepeatCodesById", + "/ed-fi/courseRepeatCodeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseRepeatCodesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -47448,48 +58771,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseRepeatCodeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseRepeatCodeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseRepeatCodesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseRepeatCodesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -47497,14 +58809,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -47516,20 +58828,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseRepeatCodeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseRepeatCode", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/courseRepeatCodeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseRepeatCodesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -47544,18 +58860,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor" - } - } - }, - "description": "The JSON representation of the CourseRepeatCode resource to be created or updated.", - "required": true, - "x-bodyName": "CourseRepeatCode" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -47573,7 +58877,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseRepeatCodeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseRepeatCodesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseRepeatCodeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseRepeatCode", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor" + } + } + }, + "description": "The JSON representation of the CourseRepeatCode resource to be created or updated.", + "required": true, + "x-bodyName": "CourseRepeatCode" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48968,6 +60387,92 @@ "sectionReference" ], "type": "object" + }, + "EdFi_CourseTranscript_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseTranscript_TrackedChangeKey": { + "properties": { + "courseAttemptResultDescriptor": { + "maxLength": 306, + "type": "string" + }, + "courseCode": { + "maxLength": 60, + "type": "string" + }, + "courseEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "courseAttemptResultDescriptor", + "courseCode", + "courseEducationOrganizationId", + "educationOrganizationId", + "schoolYear", + "studentUniqueId", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_CourseTranscript_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -49263,7 +60768,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49306,7 +60811,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -49329,27 +60834,40 @@ "StudentTranscript" ] }, - "/ed-fi/courseTranscripts/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCourseTranscriptsById", + "/ed-fi/courseTranscripts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseTranscriptsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -49363,48 +60881,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courseTranscripts" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courseTranscripts/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCourseTranscriptsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseTranscriptsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -49412,14 +60922,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CourseTranscript" + "items": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -49431,20 +60941,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courseTranscripts" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourseTranscript", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courseTranscripts/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCourseTranscriptsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -49459,18 +60976,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CourseTranscript" - } - } - }, - "description": "The JSON representation of the CourseTranscript resource to be created or updated.", - "required": true, - "x-bodyName": "CourseTranscript" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -49488,7 +60993,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courseTranscripts" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCourseTranscriptsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseTranscript" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courseTranscripts" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourseTranscript", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CourseTranscript" + } + } + }, + "description": "The JSON representation of the CourseTranscript resource to be created or updated.", + "required": true, + "x-bodyName": "CourseTranscript" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -50585,6 +62205,67 @@ "educationOrganizationId" ], "type": "object" + }, + "EdFi_Course_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Course_TrackedChangeKey": { + "properties": { + "courseCode": { + "maxLength": 60, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "courseCode", + "educationOrganizationId" + ], + "type": "object" + }, + "EdFi_Course_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -50808,7 +62489,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -50851,7 +62532,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -50878,27 +62559,40 @@ "StudentTranscript" ] }, - "/ed-fi/courses/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCoursesById", + "/ed-fi/courses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCoursesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -50912,48 +62606,44 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "courses" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courses/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCoursesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCoursesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -50961,14 +62651,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Course" + "items": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -50980,20 +62670,31 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "courses" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCourse", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courses/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCoursesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -51008,18 +62709,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Course" - } - } - }, - "description": "The JSON representation of the Course resource to be created or updated.", - "required": true, - "x-bodyName": "Course" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -51037,7 +62726,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "courses" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCoursesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Course" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "courses" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCourse", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Course" + } + } + }, + "description": "The JSON representation of the Course resource to be created or updated.", + "required": true, + "x-bodyName": "Course" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51350,6 +63154,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CredentialFieldDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CredentialFieldDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CredentialFieldDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -51466,7 +63331,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51509,7 +63374,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51529,27 +63394,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/credentialFieldDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCredentialFieldsById", + "/ed-fi/credentialFieldDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialFieldsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -51563,48 +63441,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "credentialFieldDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/credentialFieldDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCredentialFieldsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialFieldsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -51612,14 +63479,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -51631,20 +63498,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "credentialFieldDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCredentialField", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/credentialFieldDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCredentialFieldsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -51659,18 +63530,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor" - } - } - }, - "description": "The JSON representation of the CredentialField resource to be created or updated.", - "required": true, - "x-bodyName": "CredentialField" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -51688,7 +63547,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "credentialFieldDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCredentialFieldsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "credentialFieldDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCredentialField", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor" + } + } + }, + "description": "The JSON representation of the CredentialField resource to be created or updated.", + "required": true, + "x-bodyName": "CredentialField" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51913,6 +63887,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CredentialTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CredentialTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CredentialTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -52029,7 +64064,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52072,7 +64107,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52092,27 +64127,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/credentialTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCredentialTypesById", + "/ed-fi/credentialTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -52126,48 +64174,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "credentialTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/credentialTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCredentialTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -52175,14 +64212,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -52194,20 +64231,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "credentialTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCredentialType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/credentialTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCredentialTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -52222,18 +64263,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CredentialType resource to be created or updated.", - "required": true, - "x-bodyName": "CredentialType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -52251,7 +64280,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "credentialTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCredentialTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "credentialTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCredentialType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CredentialType resource to be created or updated.", + "required": true, + "x-bodyName": "CredentialType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52788,6 +64932,67 @@ "stateOfIssueStateAbbreviationDescriptor" ], "type": "object" + }, + "EdFi_Credential_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Credential_TrackedChangeKey": { + "properties": { + "credentialIdentifier": { + "maxLength": 60, + "type": "string" + }, + "stateOfIssueStateAbbreviationDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "credentialIdentifier", + "stateOfIssueStateAbbreviationDescriptor" + ], + "type": "object" + }, + "EdFi_Credential_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -52941,7 +65146,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52984,7 +65189,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53005,27 +65210,40 @@ "Staff" ] }, - "/ed-fi/credentials/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCredentialsById", + "/ed-fi/credentials/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -53039,48 +65257,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "credentials" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/credentials/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCredentialsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -53088,14 +65296,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Credential" + "items": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -53107,20 +65315,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "credentials" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCredential", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/credentials/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCredentialsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -53135,18 +65348,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Credential" - } - } - }, - "description": "The JSON representation of the Credential resource to be created or updated.", - "required": true, - "x-bodyName": "Credential" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -53164,7 +65365,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "credentials" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCredentialsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Credential" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "credentials" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCredential", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Credential" + } + } + }, + "description": "The JSON representation of the Credential resource to be created or updated.", + "required": true, + "x-bodyName": "Credential" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53419,6 +65735,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CreditCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CreditCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CreditCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -53535,7 +65912,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53578,7 +65955,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53598,27 +65975,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/creditCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCreditCategoriesById", + "/ed-fi/creditCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCreditCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -53632,48 +66022,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "creditCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/creditCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCreditCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCreditCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -53681,14 +66060,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -53700,20 +66079,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "creditCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCreditCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/creditCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCreditCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -53728,18 +66111,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the CreditCategory resource to be created or updated.", - "required": true, - "x-bodyName": "CreditCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -53757,7 +66128,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "creditCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCreditCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "creditCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCreditCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the CreditCategory resource to be created or updated.", + "required": true, + "x-bodyName": "CreditCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53982,6 +66468,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CreditTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CreditTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CreditTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -54098,7 +66645,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54141,7 +66688,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54161,27 +66708,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/creditTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCreditTypesById", + "/ed-fi/creditTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCreditTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54195,48 +66755,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "creditTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/creditTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCreditTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCreditTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -54244,14 +66793,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54263,20 +66812,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "creditTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCreditType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/creditTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCreditTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -54291,18 +66844,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CreditType resource to be created or updated.", - "required": true, - "x-bodyName": "CreditType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -54320,7 +66861,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "creditTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCreditTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "creditTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCreditType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CreditType resource to be created or updated.", + "required": true, + "x-bodyName": "CreditType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54577,6 +67233,62 @@ "crisisEventName" ], "type": "object" + }, + "EdFi_CrisisEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CrisisEvent_TrackedChangeKey": { + "properties": { + "crisisEventName": { + "maxLength": 100, + "type": "string" + } + }, + "required": [ + "crisisEventName" + ], + "type": "object" + }, + "EdFi_CrisisEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -54683,7 +67395,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54726,7 +67438,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54747,27 +67459,40 @@ "Enrollment" ] }, - "/ed-fi/crisisEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCrisisEventsById", + "/ed-fi/crisisEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCrisisEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54781,48 +67506,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "crisisEvents" ] }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/crisisEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCrisisEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCrisisEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -54830,14 +67545,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CrisisEvent" + "items": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -54849,20 +67564,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "crisisEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCrisisEvent", + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/crisisEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCrisisEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -54877,18 +67597,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CrisisEvent" - } - } - }, - "description": "The JSON representation of the CrisisEvent resource to be created or updated.", - "required": true, - "x-bodyName": "CrisisEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -54906,7 +67614,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "crisisEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCrisisEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CrisisEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "crisisEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCrisisEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CrisisEvent" + } + } + }, + "description": "The JSON representation of the CrisisEvent resource to be created or updated.", + "required": true, + "x-bodyName": "CrisisEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55125,6 +67948,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CrisisTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CrisisTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CrisisTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -55241,7 +68125,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55284,7 +68168,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55304,27 +68188,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/crisisTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCrisisTypesById", + "/ed-fi/crisisTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCrisisTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -55338,48 +68235,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "crisisTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/crisisTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCrisisTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCrisisTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -55387,14 +68273,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -55406,20 +68292,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "crisisTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCrisisType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/crisisTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCrisisTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -55434,18 +68324,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor" - } - } - }, - "description": "The JSON representation of the CrisisType resource to be created or updated.", - "required": true, - "x-bodyName": "CrisisType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -55463,7 +68341,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "crisisTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCrisisTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "crisisTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCrisisType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor" + } + } + }, + "description": "The JSON representation of the CrisisType resource to be created or updated.", + "required": true, + "x-bodyName": "CrisisType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55688,6 +68681,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CteProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CteProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CteProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -55804,7 +68858,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55847,7 +68901,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55867,27 +68921,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/cteProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCTEProgramServicesById", + "/ed-fi/cteProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCTEProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -55901,48 +68968,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "cteProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cteProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCTEProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCTEProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -55950,14 +69006,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -55969,20 +69025,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "cteProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCTEProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/cteProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCTEProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -55997,18 +69057,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the CTEProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "CTEProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -56026,7 +69074,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "cteProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCTEProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "cteProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCTEProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the CTEProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "CTEProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56251,6 +69414,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CurriculumUsedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CurriculumUsedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CurriculumUsedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -56367,7 +69591,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56410,7 +69634,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56430,27 +69654,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/curriculumUsedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteCurriculumUsedsById", + "/ed-fi/curriculumUsedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCurriculumUsedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -56464,48 +69701,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "curriculumUsedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/curriculumUsedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getCurriculumUsedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCurriculumUsedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -56513,14 +69739,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -56532,20 +69758,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "curriculumUsedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putCurriculumUsed", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/curriculumUsedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteCurriculumUsedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -56560,18 +69790,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor" - } - } - }, - "description": "The JSON representation of the CurriculumUsed resource to be created or updated.", - "required": true, - "x-bodyName": "CurriculumUsed" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -56589,7 +69807,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "curriculumUsedDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getCurriculumUsedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "curriculumUsedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putCurriculumUsed", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor" + } + } + }, + "description": "The JSON representation of the CurriculumUsed resource to be created or updated.", + "required": true, + "x-bodyName": "CurriculumUsed" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56814,6 +70147,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DeliveryMethodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DeliveryMethodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DeliveryMethodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -56930,7 +70324,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56973,7 +70367,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56993,27 +70387,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/deliveryMethodDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDeliveryMethodsById", + "/ed-fi/deliveryMethodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDeliveryMethodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -57027,48 +70434,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "deliveryMethodDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/deliveryMethodDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDeliveryMethodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDeliveryMethodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -57076,14 +70472,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -57095,20 +70491,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "deliveryMethodDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDeliveryMethod", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/deliveryMethodDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDeliveryMethodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -57123,18 +70523,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor" - } - } - }, - "description": "The JSON representation of the DeliveryMethod resource to be created or updated.", - "required": true, - "x-bodyName": "DeliveryMethod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -57152,7 +70540,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "deliveryMethodDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDeliveryMethodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "deliveryMethodDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDeliveryMethod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor" + } + } + }, + "description": "The JSON representation of the DeliveryMethod resource to be created or updated.", + "required": true, + "x-bodyName": "DeliveryMethod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -57478,6 +70981,79 @@ "value" ], "type": "object" + }, + "EdFi_DescriptorMapping_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DescriptorMapping_TrackedChangeKey": { + "properties": { + "mappedNamespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "mappedValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "value": { + "maxLength": 50, + "type": "string" + } + }, + "required": [ + "mappedNamespace", + "mappedValue", + "namespace", + "value" + ], + "type": "object" + }, + "EdFi_DescriptorMapping_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -57580,7 +71156,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -57623,7 +71199,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -57643,27 +71219,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/descriptorMappings/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDescriptorMappingsById", + "/ed-fi/descriptorMappings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDescriptorMappingsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -57677,48 +71266,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "descriptorMappings" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/descriptorMappings/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDescriptorMappingsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDescriptorMappingsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -57726,14 +71304,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DescriptorMapping" + "items": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -57745,20 +71323,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "descriptorMappings" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDescriptorMapping", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/descriptorMappings/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDescriptorMappingsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -57773,18 +71355,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DescriptorMapping" - } - } - }, - "description": "The JSON representation of the DescriptorMapping resource to be created or updated.", - "required": true, - "x-bodyName": "DescriptorMapping" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -57802,7 +71372,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "descriptorMappings" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDescriptorMappingsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "descriptorMappings" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDescriptorMapping", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping" + } + } + }, + "description": "The JSON representation of the DescriptorMapping resource to be created or updated.", + "required": true, + "x-bodyName": "DescriptorMapping" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -58015,6 +71700,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DiagnosisDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DiagnosisDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DiagnosisDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -58131,7 +71877,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -58174,7 +71920,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -58194,27 +71940,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/diagnosisDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDiagnosesById", + "/ed-fi/diagnosisDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDiagnosesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -58228,48 +71987,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "diagnosisDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diagnosisDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDiagnosesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDiagnosesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -58277,14 +72025,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -58296,20 +72044,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "diagnosisDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDiagnosis", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diagnosisDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDiagnosesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -58324,18 +72076,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor" - } - } - }, - "description": "The JSON representation of the Diagnosis resource to be created or updated.", - "required": true, - "x-bodyName": "Diagnosis" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -58353,7 +72093,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "diagnosisDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDiagnosesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "diagnosisDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDiagnosis", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor" + } + } + }, + "description": "The JSON representation of the Diagnosis resource to be created or updated.", + "required": true, + "x-bodyName": "Diagnosis" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -58578,6 +72433,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DiplomaLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DiplomaLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DiplomaLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -58694,7 +72610,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -58737,7 +72653,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -58757,27 +72673,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/diplomaLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDiplomaLevelsById", + "/ed-fi/diplomaLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -58791,48 +72720,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "diplomaLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diplomaLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDiplomaLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -58840,14 +72758,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -58859,20 +72777,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "diplomaLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDiplomaLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diplomaLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDiplomaLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -58887,18 +72809,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor" - } - } - }, - "description": "The JSON representation of the DiplomaLevel resource to be created or updated.", - "required": true, - "x-bodyName": "DiplomaLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -58916,7 +72826,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "diplomaLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDiplomaLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "diplomaLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDiplomaLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor" + } + } + }, + "description": "The JSON representation of the DiplomaLevel resource to be created or updated.", + "required": true, + "x-bodyName": "DiplomaLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -59141,6 +73166,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DiplomaTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DiplomaTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DiplomaTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -59257,7 +73343,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59300,7 +73386,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -59320,27 +73406,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/diplomaTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDiplomaTypesById", + "/ed-fi/diplomaTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -59354,48 +73453,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "diplomaTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diplomaTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDiplomaTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -59403,14 +73491,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -59422,20 +73510,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "diplomaTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDiplomaType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/diplomaTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDiplomaTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -59450,18 +73542,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor" - } - } - }, - "description": "The JSON representation of the DiplomaType resource to be created or updated.", - "required": true, - "x-bodyName": "DiplomaType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -59479,7 +73559,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "diplomaTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDiplomaTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "diplomaTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDiplomaType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor" + } + } + }, + "description": "The JSON representation of the DiplomaType resource to be created or updated.", + "required": true, + "x-bodyName": "DiplomaType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -59704,6 +73899,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -59820,7 +74076,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59863,7 +74119,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -59883,27 +74139,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disabilityDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisabilitiesById", + "/ed-fi/disabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilitiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -59917,48 +74186,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disabilityDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisabilitiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilitiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -59966,14 +74224,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -59985,20 +74243,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disabilityDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisability", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisabilitiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -60013,18 +74275,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDescriptor" - } - } - }, - "description": "The JSON representation of the Disability resource to be created or updated.", - "required": true, - "x-bodyName": "Disability" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -60042,7 +74292,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disabilityDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisabilitiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disabilityDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisability", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor" + } + } + }, + "description": "The JSON representation of the Disability resource to be created or updated.", + "required": true, + "x-bodyName": "Disability" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -60267,6 +74632,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisabilityDesignationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisabilityDesignationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisabilityDesignationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -60383,7 +74809,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -60426,7 +74852,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -60446,27 +74872,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disabilityDesignationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisabilityDesignationsById", + "/ed-fi/disabilityDesignationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDesignationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -60480,48 +74919,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disabilityDesignationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDesignationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisabilityDesignationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDesignationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -60529,14 +74957,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -60548,20 +74976,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disabilityDesignationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisabilityDesignation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDesignationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisabilityDesignationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -60576,18 +75008,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor" - } - } - }, - "description": "The JSON representation of the DisabilityDesignation resource to be created or updated.", - "required": true, - "x-bodyName": "DisabilityDesignation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -60605,7 +75025,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disabilityDesignationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisabilityDesignationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disabilityDesignationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisabilityDesignation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor" + } + } + }, + "description": "The JSON representation of the DisabilityDesignation resource to be created or updated.", + "required": true, + "x-bodyName": "DisabilityDesignation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -60830,6 +75365,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -60946,7 +75542,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -60989,7 +75585,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -61009,27 +75605,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disabilityDeterminationSourceTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisabilityDeterminationSourceTypesById", + "/ed-fi/disabilityDeterminationSourceTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDeterminationSourceTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -61043,48 +75652,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disabilityDeterminationSourceTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDeterminationSourceTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisabilityDeterminationSourceTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDeterminationSourceTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -61092,14 +75690,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -61111,20 +75709,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disabilityDeterminationSourceTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisabilityDeterminationSourceType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disabilityDeterminationSourceTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisabilityDeterminationSourceTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -61139,18 +75741,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor" - } - } - }, - "description": "The JSON representation of the DisabilityDeterminationSourceType resource to be created or updated.", - "required": true, - "x-bodyName": "DisabilityDeterminationSourceType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -61168,7 +75758,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disabilityDeterminationSourceTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisabilityDeterminationSourceTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disabilityDeterminationSourceTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisabilityDeterminationSourceType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor" + } + } + }, + "description": "The JSON representation of the DisabilityDeterminationSourceType resource to be created or updated.", + "required": true, + "x-bodyName": "DisabilityDeterminationSourceType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -61393,6 +76098,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -61509,7 +76275,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -61552,7 +76318,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -61572,27 +76338,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisciplineActionLengthDifferenceReasonsById", + "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionLengthDifferenceReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -61606,48 +76385,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disciplineActionLengthDifferenceReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisciplineActionLengthDifferenceReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionLengthDifferenceReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -61655,14 +76423,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -61674,20 +76442,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disciplineActionLengthDifferenceReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisciplineActionLengthDifferenceReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisciplineActionLengthDifferenceReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -61702,18 +76474,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor" - } - } - }, - "description": "The JSON representation of the DisciplineActionLengthDifferenceReason resource to be created or updated.", - "required": true, - "x-bodyName": "DisciplineActionLengthDifferenceReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -61731,7 +76491,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disciplineActionLengthDifferenceReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisciplineActionLengthDifferenceReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disciplineActionLengthDifferenceReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisciplineActionLengthDifferenceReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor" + } + } + }, + "description": "The JSON representation of the DisciplineActionLengthDifferenceReason resource to be created or updated.", + "required": true, + "x-bodyName": "DisciplineActionLengthDifferenceReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62375,6 +77250,72 @@ "studentDisciplineIncidentBehaviorAssociationReference" ], "type": "object" + }, + "EdFi_DisciplineAction_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineAction_TrackedChangeKey": { + "properties": { + "disciplineActionIdentifier": { + "maxLength": 36, + "type": "string" + }, + "disciplineDate": { + "format": "date", + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "disciplineActionIdentifier", + "disciplineDate", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_DisciplineAction_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -62528,7 +77469,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62571,7 +77512,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62592,27 +77533,40 @@ "Discipline" ] }, - "/ed-fi/disciplineActions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisciplineActionsById", + "/ed-fi/disciplineActions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -62626,48 +77580,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disciplineActions" ] }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineActions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisciplineActionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -62675,14 +77619,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineAction" + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -62694,20 +77638,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disciplineActions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisciplineAction", + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineActions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisciplineActionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -62722,18 +77671,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineAction" - } - } - }, - "description": "The JSON representation of the DisciplineAction resource to be created or updated.", - "required": true, - "x-bodyName": "DisciplineAction" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -62751,7 +77688,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disciplineActions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisciplineActionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineAction" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disciplineActions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisciplineAction", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineAction" + } + } + }, + "description": "The JSON representation of the DisciplineAction resource to be created or updated.", + "required": true, + "x-bodyName": "DisciplineAction" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63011,6 +78063,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisciplineDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisciplineDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -63127,7 +78240,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63170,7 +78283,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63190,27 +78303,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disciplineDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisciplinesById", + "/ed-fi/disciplineDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplinesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -63224,48 +78350,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disciplineDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisciplinesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplinesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -63273,14 +78388,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -63292,20 +78407,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disciplineDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDiscipline", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisciplinesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -63320,18 +78439,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineDescriptor" - } - } - }, - "description": "The JSON representation of the Discipline resource to be created or updated.", - "required": true, - "x-bodyName": "Discipline" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -63349,7 +78456,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disciplineDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisciplinesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disciplineDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDiscipline", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor" + } + } + }, + "description": "The JSON representation of the Discipline resource to be created or updated.", + "required": true, + "x-bodyName": "Discipline" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63574,6 +78796,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -63690,7 +78973,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63733,7 +79016,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63753,27 +79036,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/disciplineIncidentParticipationCodeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisciplineIncidentParticipationCodesById", + "/ed-fi/disciplineIncidentParticipationCodeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentParticipationCodesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -63787,48 +79083,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disciplineIncidentParticipationCodeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineIncidentParticipationCodeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisciplineIncidentParticipationCodesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentParticipationCodesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -63836,14 +79121,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -63855,20 +79140,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disciplineIncidentParticipationCodeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisciplineIncidentParticipationCode", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/disciplineIncidentParticipationCodeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisciplineIncidentParticipationCodesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -63883,18 +79172,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor" - } - } - }, - "description": "The JSON representation of the DisciplineIncidentParticipationCode resource to be created or updated.", - "required": true, - "x-bodyName": "DisciplineIncidentParticipationCode" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -63912,7 +79189,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disciplineIncidentParticipationCodeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisciplineIncidentParticipationCodesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disciplineIncidentParticipationCodeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisciplineIncidentParticipationCode", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor" + } + } + }, + "description": "The JSON representation of the DisciplineIncidentParticipationCode resource to be created or updated.", + "required": true, + "x-bodyName": "DisciplineIncidentParticipationCode" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -64522,6 +79914,67 @@ ], "type": "object" }, + "EdFi_DisciplineIncident_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineIncident_TrackedChangeKey": { + "properties": { + "incidentIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "incidentIdentifier", + "schoolId" + ], + "type": "object" + }, + "EdFi_DisciplineIncident_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_DisciplineIncident_Weapon": { "properties": { "weaponDescriptor": { @@ -64693,7 +80146,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -64736,7 +80189,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -64757,27 +80210,40 @@ "Discipline" ] }, - "/ed-fi/disciplineIncidents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisciplineIncidentsById", + "/ed-fi/disciplineIncidents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -64791,48 +80257,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "disciplineIncidents" ] }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineIncidents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisciplineIncidentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -64840,14 +80296,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineIncident" + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -64859,20 +80315,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "disciplineIncidents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisciplineIncident", + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineIncidents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisciplineIncidentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -64887,18 +80348,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisciplineIncident" - } - } - }, - "description": "The JSON representation of the DisciplineIncident resource to be created or updated.", - "required": true, - "x-bodyName": "DisciplineIncident" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -64916,7 +80365,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "disciplineIncidents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisciplineIncidentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "disciplineIncidents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisciplineIncident", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident" + } + } + }, + "description": "The JSON representation of the DisciplineIncident resource to be created or updated.", + "required": true, + "x-bodyName": "DisciplineIncident" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -65180,6 +80744,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisplacedStudentStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -65296,7 +80921,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -65339,7 +80964,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -65359,27 +80984,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/displacedStudentStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDisplacedStudentStatusesById", + "/ed-fi/displacedStudentStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisplacedStudentStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -65393,48 +81031,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "displacedStudentStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/displacedStudentStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDisplacedStudentStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisplacedStudentStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -65442,14 +81069,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -65461,20 +81088,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "displacedStudentStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDisplacedStudentStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/displacedStudentStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDisplacedStudentStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -65489,18 +81120,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor" - } - } - }, - "description": "The JSON representation of the DisplacedStudentStatus resource to be created or updated.", - "required": true, - "x-bodyName": "DisplacedStudentStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -65518,7 +81137,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "displacedStudentStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDisplacedStudentStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "displacedStudentStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDisplacedStudentStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor" + } + } + }, + "description": "The JSON representation of the DisplacedStudentStatus resource to be created or updated.", + "required": true, + "x-bodyName": "DisplacedStudentStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -65743,6 +81477,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DualCreditInstitutionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DualCreditInstitutionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DualCreditInstitutionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -65859,7 +81654,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -65902,7 +81697,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -65922,27 +81717,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/dualCreditInstitutionDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDualCreditInstitutionsById", + "/ed-fi/dualCreditInstitutionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDualCreditInstitutionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -65956,48 +81764,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "dualCreditInstitutionDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/dualCreditInstitutionDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDualCreditInstitutionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDualCreditInstitutionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -66005,14 +81802,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -66024,20 +81821,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "dualCreditInstitutionDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDualCreditInstitution", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/dualCreditInstitutionDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDualCreditInstitutionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -66052,18 +81853,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor" - } - } - }, - "description": "The JSON representation of the DualCreditInstitution resource to be created or updated.", - "required": true, - "x-bodyName": "DualCreditInstitution" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -66081,7 +81870,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "dualCreditInstitutionDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDualCreditInstitutionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "dualCreditInstitutionDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDualCreditInstitution", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor" + } + } + }, + "description": "The JSON representation of the DualCreditInstitution resource to be created or updated.", + "required": true, + "x-bodyName": "DualCreditInstitution" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66306,6 +82210,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DualCreditTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DualCreditTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DualCreditTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -66422,7 +82387,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66465,7 +82430,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66485,27 +82450,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/dualCreditTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteDualCreditTypesById", + "/ed-fi/dualCreditTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDualCreditTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -66519,48 +82497,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "dualCreditTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/dualCreditTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getDualCreditTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDualCreditTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -66568,14 +82535,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -66587,20 +82554,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "dualCreditTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putDualCreditType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/dualCreditTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteDualCreditTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -66615,18 +82586,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor" - } - } - }, - "description": "The JSON representation of the DualCreditType resource to be created or updated.", - "required": true, - "x-bodyName": "DualCreditType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -66644,7 +82603,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "dualCreditTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getDualCreditTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "dualCreditTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putDualCreditType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor" + } + } + }, + "description": "The JSON representation of the DualCreditType resource to be created or updated.", + "required": true, + "x-bodyName": "DualCreditType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67508,6 +83582,62 @@ "contentIdentifier" ], "type": "object" + }, + "EdFi_EducationContent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationContent_TrackedChangeKey": { + "properties": { + "contentIdentifier": { + "maxLength": 225, + "type": "string" + } + }, + "required": [ + "contentIdentifier" + ], + "type": "object" + }, + "EdFi_EducationContent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -67725,7 +83855,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67768,7 +83898,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67789,27 +83919,40 @@ "Intervention" ] }, - "/ed-fi/educationContents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationContentsById", + "/ed-fi/educationContents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationContentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -67823,48 +83966,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationContents" ] }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/educationContents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationContentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationContentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -67872,14 +84005,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationContent" + "items": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -67891,20 +84024,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationContents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationContent", + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/educationContents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationContentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -67919,18 +84057,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationContent" - } - } - }, - "description": "The JSON representation of the EducationContent resource to be created or updated.", - "required": true, - "x-bodyName": "EducationContent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -67948,7 +84074,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationContents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationContentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationContent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationContents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationContent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationContent" + } + } + }, + "description": "The JSON representation of the EducationContent resource to be created or updated.", + "required": true, + "x-bodyName": "EducationContent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68245,6 +84486,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -68361,7 +84663,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68404,7 +84706,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68424,27 +84726,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationOrganizationAssociationTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationAssociationTypesById", + "/ed-fi/educationOrganizationAssociationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationAssociationTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -68458,48 +84773,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationAssociationTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationAssociationTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationAssociationTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationAssociationTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -68507,14 +84811,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -68526,20 +84830,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationAssociationTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationAssociationType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationAssociationTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationAssociationTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -68554,18 +84862,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor" - } - } - }, - "description": "The JSON representation of the EducationOrganizationAssociationType resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationAssociationType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -68583,7 +84879,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationAssociationTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationAssociationTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationAssociationTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationAssociationType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor" + } + } + }, + "description": "The JSON representation of the EducationOrganizationAssociationType resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationAssociationType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68808,6 +85219,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -68924,7 +85396,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68967,7 +85439,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68987,27 +85459,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationOrganizationCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationCategoriesById", + "/ed-fi/educationOrganizationCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -69021,48 +85506,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -69070,14 +85544,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -69089,20 +85563,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -69117,18 +85595,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the EducationOrganizationCategory resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -69146,7 +85612,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the EducationOrganizationCategory resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69371,6 +85952,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -69487,7 +86129,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69530,7 +86172,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69550,27 +86192,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationOrganizationIdentificationSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationIdentificationSystemsById", + "/ed-fi/educationOrganizationIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationIdentificationSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -69584,48 +86239,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationIdentificationSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationIdentificationSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationIdentificationSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationIdentificationSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -69633,14 +86277,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -69652,20 +86296,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationIdentificationSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationIdentificationSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationIdentificationSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationIdentificationSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -69680,18 +86328,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor" - } - } - }, - "description": "The JSON representation of the EducationOrganizationIdentificationSystem resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationIdentificationSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -69709,7 +86345,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationIdentificationSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationIdentificationSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationIdentificationSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationIdentificationSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor" + } + } + }, + "description": "The JSON representation of the EducationOrganizationIdentificationSystem resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationIdentificationSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70005,6 +86756,72 @@ "interventionPrescriptionIdentificationCode" ], "type": "object" + }, + "EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionPrescriptionEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionPrescriptionIdentificationCode": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionPrescriptionEducationOrganizationId", + "interventionPrescriptionIdentificationCode" + ], + "type": "object" + }, + "EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -70113,7 +86930,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70156,7 +86973,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70177,27 +86994,40 @@ "Intervention" ] }, - "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationInterventionPrescriptionAssociationsById", + "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -70211,48 +87041,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationInterventionPrescriptionAssociations" ] }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -70260,14 +87080,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -70279,20 +87099,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationInterventionPrescriptionAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationInterventionPrescriptionAssociation", + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationInterventionPrescriptionAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -70307,18 +87132,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation" - } - } - }, - "description": "The JSON representation of the EducationOrganizationInterventionPrescriptionAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationInterventionPrescriptionAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -70336,7 +87149,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationInterventionPrescriptionAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationInterventionPrescriptionAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationInterventionPrescriptionAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation" + } + } + }, + "description": "The JSON representation of the EducationOrganizationInterventionPrescriptionAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationInterventionPrescriptionAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70615,6 +87543,67 @@ "memberEducationOrganizationId" ], "type": "object" + }, + "EdFi_EducationOrganizationNetworkAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationNetworkId": { + "format": "int64", + "type": "integer" + }, + "memberEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationOrganizationNetworkId", + "memberEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -70713,7 +87702,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70756,7 +87745,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70777,27 +87766,40 @@ "EducationOrganization" ] }, - "/ed-fi/educationOrganizationNetworkAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationNetworkAssociationsById", + "/ed-fi/educationOrganizationNetworkAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworkAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -70811,48 +87813,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationNetworkAssociations" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationNetworkAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationNetworkAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworkAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -70860,14 +87852,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -70879,20 +87871,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationNetworkAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationNetworkAssociation", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationNetworkAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationNetworkAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -70907,18 +87904,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation" - } - } - }, - "description": "The JSON representation of the EducationOrganizationNetworkAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationNetworkAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -70936,7 +87921,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationNetworkAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationNetworkAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationNetworkAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationNetworkAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation" + } + } + }, + "description": "The JSON representation of the EducationOrganizationNetworkAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationNetworkAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -71937,6 +89037,62 @@ ], "type": "object" }, + "EdFi_EducationOrganizationNetwork_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetwork_TrackedChangeKey": { + "properties": { + "educationOrganizationNetworkId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationOrganizationNetworkId" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetwork_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_EducationOrganization_Address": { "properties": { "addressTypeDescriptor": { @@ -72334,7 +89490,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72377,7 +89533,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72398,27 +89554,40 @@ "EducationOrganization" ] }, - "/ed-fi/educationOrganizationNetworks/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationNetworksById", + "/ed-fi/educationOrganizationNetworks/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworksDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -72432,48 +89601,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationNetworks" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationNetworks/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationNetworksById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworksKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -72481,14 +89640,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -72500,20 +89659,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationNetworks" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationNetwork", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationNetworks/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationNetworksById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -72528,18 +89692,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork" - } - } - }, - "description": "The JSON representation of the EducationOrganizationNetwork resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationNetwork" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -72557,7 +89709,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationNetworks" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationNetworksById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationNetworks" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationNetwork", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork" + } + } + }, + "description": "The JSON representation of the EducationOrganizationNetwork resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationNetwork" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72809,6 +90076,67 @@ "peerEducationOrganizationId" ], "type": "object" + }, + "EdFi_EducationOrganizationPeerAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "peerEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationOrganizationId", + "peerEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_EducationOrganizationPeerAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -72889,7 +90217,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72932,7 +90260,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72952,27 +90280,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationOrganizationPeerAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationOrganizationPeerAssociationsById", + "/ed-fi/educationOrganizationPeerAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationPeerAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -72986,48 +90327,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationOrganizationPeerAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationPeerAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationOrganizationPeerAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationPeerAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -73035,14 +90365,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -73054,20 +90384,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationOrganizationPeerAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationOrganizationPeerAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationOrganizationPeerAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationOrganizationPeerAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -73082,18 +90416,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation" - } - } - }, - "description": "The JSON representation of the EducationOrganizationPeerAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "EducationOrganizationPeerAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -73111,7 +90433,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationOrganizationPeerAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationOrganizationPeerAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationOrganizationPeerAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationOrganizationPeerAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation" + } + } + }, + "description": "The JSON representation of the EducationOrganizationPeerAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "EducationOrganizationPeerAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -73320,6 +90757,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationPlanDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationPlanDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationPlanDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -73436,7 +90934,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73479,7 +90977,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -73499,27 +90997,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationPlanDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationPlansById", + "/ed-fi/educationPlanDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationPlansDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -73533,48 +91044,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationPlanDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationPlanDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationPlansById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationPlansKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -73582,14 +91082,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -73601,20 +91101,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationPlanDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationPlan", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationPlanDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationPlansById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -73629,18 +91133,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor" - } - } - }, - "description": "The JSON representation of the EducationPlan resource to be created or updated.", - "required": true, - "x-bodyName": "EducationPlan" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -73658,7 +91150,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationPlanDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationPlansById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationPlanDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationPlan", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor" + } + } + }, + "description": "The JSON representation of the EducationPlan resource to be created or updated.", + "required": true, + "x-bodyName": "EducationPlan" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -74956,6 +92563,62 @@ "educationServiceCenterId" ], "type": "object" + }, + "EdFi_EducationServiceCenter_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationServiceCenter_TrackedChangeKey": { + "properties": { + "educationServiceCenterId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationServiceCenterId" + ], + "type": "object" + }, + "EdFi_EducationServiceCenter_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -75073,7 +92736,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -75116,7 +92779,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -75138,27 +92801,40 @@ "Staff" ] }, - "/ed-fi/educationServiceCenters/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationServiceCentersById", + "/ed-fi/educationServiceCenters/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationServiceCentersDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -75172,48 +92848,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationServiceCenters" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, + "/ed-fi/educationServiceCenters/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationServiceCentersById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationServiceCentersKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -75221,14 +92888,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationServiceCenter" + "items": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -75240,20 +92907,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationServiceCenters" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationServiceCenter", + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, + "/ed-fi/educationServiceCenters/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationServiceCentersById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -75268,18 +92941,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationServiceCenter" - } - } - }, - "description": "The JSON representation of the EducationServiceCenter resource to be created or updated.", - "required": true, - "x-bodyName": "EducationServiceCenter" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -75297,7 +92958,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationServiceCenters" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationServiceCentersById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationServiceCenters" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationServiceCenter", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter" + } + } + }, + "description": "The JSON representation of the EducationServiceCenter resource to be created or updated.", + "required": true, + "x-bodyName": "EducationServiceCenter" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -75538,6 +93314,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationalEnvironmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationalEnvironmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -75654,7 +93491,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -75697,7 +93534,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -75717,27 +93554,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/educationalEnvironmentDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEducationalEnvironmentsById", + "/ed-fi/educationalEnvironmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationalEnvironmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -75751,48 +93601,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educationalEnvironmentDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationalEnvironmentDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEducationalEnvironmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationalEnvironmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -75800,14 +93639,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -75819,20 +93658,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educationalEnvironmentDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEducationalEnvironment", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/educationalEnvironmentDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEducationalEnvironmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -75847,18 +93690,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor" - } - } - }, - "description": "The JSON representation of the EducationalEnvironment resource to be created or updated.", - "required": true, - "x-bodyName": "EducationalEnvironment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -75876,7 +93707,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "educationalEnvironmentDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEducationalEnvironmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "educationalEnvironmentDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEducationalEnvironment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor" + } + } + }, + "description": "The JSON representation of the EducationalEnvironment resource to be created or updated.", + "required": true, + "x-bodyName": "EducationalEnvironment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76101,6 +94047,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ElectronicMailTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ElectronicMailTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -76217,7 +94224,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -76260,7 +94267,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76280,27 +94287,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/electronicMailTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteElectronicMailTypesById", + "/ed-fi/electronicMailTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getElectronicMailTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -76314,48 +94334,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "electronicMailTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/electronicMailTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getElectronicMailTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getElectronicMailTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -76363,14 +94372,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -76382,20 +94391,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "electronicMailTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putElectronicMailType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/electronicMailTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteElectronicMailTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -76410,18 +94423,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ElectronicMailType resource to be created or updated.", - "required": true, - "x-bodyName": "ElectronicMailType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -76439,7 +94440,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "electronicMailTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getElectronicMailTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "electronicMailTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putElectronicMailType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ElectronicMailType resource to be created or updated.", + "required": true, + "x-bodyName": "ElectronicMailType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76664,6 +94780,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EligibilityDelayReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -76780,7 +94957,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -76823,7 +95000,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76843,27 +95020,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/eligibilityDelayReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEligibilityDelayReasonsById", + "/ed-fi/eligibilityDelayReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityDelayReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -76877,48 +95067,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "eligibilityDelayReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eligibilityDelayReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEligibilityDelayReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityDelayReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -76926,14 +95105,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -76945,20 +95124,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "eligibilityDelayReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEligibilityDelayReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eligibilityDelayReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEligibilityDelayReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -76973,18 +95156,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor" - } - } - }, - "description": "The JSON representation of the EligibilityDelayReason resource to be created or updated.", - "required": true, - "x-bodyName": "EligibilityDelayReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -77002,7 +95173,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "eligibilityDelayReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEligibilityDelayReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "eligibilityDelayReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEligibilityDelayReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor" + } + } + }, + "description": "The JSON representation of the EligibilityDelayReason resource to be created or updated.", + "required": true, + "x-bodyName": "EligibilityDelayReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77227,6 +95513,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -77343,7 +95690,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77386,7 +95733,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77406,27 +95753,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/eligibilityEvaluationTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEligibilityEvaluationTypesById", + "/ed-fi/eligibilityEvaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityEvaluationTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -77440,48 +95800,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "eligibilityEvaluationTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eligibilityEvaluationTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEligibilityEvaluationTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityEvaluationTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -77489,14 +95838,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -77508,20 +95857,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "eligibilityEvaluationTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEligibilityEvaluationType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eligibilityEvaluationTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEligibilityEvaluationTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -77536,18 +95889,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor" - } - } - }, - "description": "The JSON representation of the EligibilityEvaluationType resource to be created or updated.", - "required": true, - "x-bodyName": "EligibilityEvaluationType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -77565,7 +95906,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "eligibilityEvaluationTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEligibilityEvaluationTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "eligibilityEvaluationTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEligibilityEvaluationType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor" + } + } + }, + "description": "The JSON representation of the EligibilityEvaluationType resource to be created or updated.", + "required": true, + "x-bodyName": "EligibilityEvaluationType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77790,6 +96246,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EmploymentStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EmploymentStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EmploymentStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -77906,7 +96423,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77949,7 +96466,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77969,27 +96486,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/employmentStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEmploymentStatusesById", + "/ed-fi/employmentStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEmploymentStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -78003,48 +96533,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "employmentStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/employmentStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEmploymentStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEmploymentStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -78052,14 +96571,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -78071,20 +96590,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "employmentStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEmploymentStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/employmentStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEmploymentStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -78099,18 +96622,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor" - } - } - }, - "description": "The JSON representation of the EmploymentStatus resource to be created or updated.", - "required": true, - "x-bodyName": "EmploymentStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -78128,7 +96639,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "employmentStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEmploymentStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "employmentStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEmploymentStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor" + } + } + }, + "description": "The JSON representation of the EmploymentStatus resource to be created or updated.", + "required": true, + "x-bodyName": "EmploymentStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78353,6 +96979,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EnrollmentTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EnrollmentTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EnrollmentTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -78469,7 +97156,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78512,7 +97199,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78532,27 +97219,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/enrollmentTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEnrollmentTypesById", + "/ed-fi/enrollmentTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEnrollmentTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -78566,48 +97266,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "enrollmentTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/enrollmentTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEnrollmentTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEnrollmentTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -78615,14 +97304,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -78634,20 +97323,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "enrollmentTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEnrollmentType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/enrollmentTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEnrollmentTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -78662,18 +97355,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor" - } - } - }, - "description": "The JSON representation of the EnrollmentType resource to be created or updated.", - "required": true, - "x-bodyName": "EnrollmentType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -78691,7 +97372,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "enrollmentTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEnrollmentTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "enrollmentTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEnrollmentType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor" + } + } + }, + "description": "The JSON representation of the EnrollmentType resource to be created or updated.", + "required": true, + "x-bodyName": "EnrollmentType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78916,6 +97712,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -79032,7 +97889,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79075,7 +97932,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79095,27 +97952,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/entryGradeLevelReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEntryGradeLevelReasonsById", + "/ed-fi/entryGradeLevelReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEntryGradeLevelReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -79129,48 +97999,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "entryGradeLevelReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/entryGradeLevelReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEntryGradeLevelReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEntryGradeLevelReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -79178,14 +98037,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -79197,20 +98056,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "entryGradeLevelReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEntryGradeLevelReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/entryGradeLevelReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEntryGradeLevelReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -79225,18 +98088,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor" - } - } - }, - "description": "The JSON representation of the EntryGradeLevelReason resource to be created or updated.", - "required": true, - "x-bodyName": "EntryGradeLevelReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -79254,7 +98105,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "entryGradeLevelReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEntryGradeLevelReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "entryGradeLevelReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEntryGradeLevelReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor" + } + } + }, + "description": "The JSON representation of the EntryGradeLevelReason resource to be created or updated.", + "required": true, + "x-bodyName": "EntryGradeLevelReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79479,6 +98445,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EntryTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EntryTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EntryTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -79595,7 +98622,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79638,7 +98665,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79658,27 +98685,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/entryTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEntryTypesById", + "/ed-fi/entryTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEntryTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -79692,48 +98732,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "entryTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/entryTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEntryTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEntryTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -79741,14 +98770,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -79760,20 +98789,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "entryTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEntryType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/entryTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEntryTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -79788,18 +98821,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor" - } - } - }, - "description": "The JSON representation of the EntryType resource to be created or updated.", - "required": true, - "x-bodyName": "EntryType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -79817,7 +98838,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "entryTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEntryTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "entryTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEntryType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor" + } + } + }, + "description": "The JSON representation of the EntryType resource to be created or updated.", + "required": true, + "x-bodyName": "EntryType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -80042,6 +99178,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EvaluationDelayReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -80158,7 +99355,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80201,7 +99398,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -80221,27 +99418,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/evaluationDelayReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEvaluationDelayReasonsById", + "/ed-fi/evaluationDelayReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationDelayReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -80255,48 +99465,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationDelayReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/evaluationDelayReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEvaluationDelayReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationDelayReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -80304,14 +99503,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -80323,20 +99522,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationDelayReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEvaluationDelayReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/evaluationDelayReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEvaluationDelayReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -80351,18 +99554,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor" - } - } - }, - "description": "The JSON representation of the EvaluationDelayReason resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationDelayReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -80380,7 +99571,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "evaluationDelayReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEvaluationDelayReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "evaluationDelayReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEvaluationDelayReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor" + } + } + }, + "description": "The JSON representation of the EvaluationDelayReason resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationDelayReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -80780,6 +100086,97 @@ "programEvaluationElementTitle" ], "type": "object" + }, + "EdFi_EvaluationRubricDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationRubricDimension_TrackedChangeKey": { + "properties": { + "evaluationRubricRating": { + "format": "int32", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationElementTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "evaluationRubricRating", + "programEducationOrganizationId", + "programEvaluationElementTitle", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_EvaluationRubricDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -80947,7 +100344,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80990,7 +100387,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81011,27 +100408,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/evaluationRubricDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEvaluationRubricDimensionsById", + "/ed-fi/evaluationRubricDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRubricDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -81045,48 +100455,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationRubricDimensions" ] }, + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/evaluationRubricDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEvaluationRubricDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRubricDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -81094,14 +100494,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension" + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -81113,20 +100513,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationRubricDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEvaluationRubricDimension", + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/evaluationRubricDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEvaluationRubricDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -81141,18 +100546,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension" - } - } - }, - "description": "The JSON representation of the EvaluationRubricDimension resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationRubricDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -81170,7 +100563,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "evaluationRubricDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEvaluationRubricDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "evaluationRubricDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEvaluationRubricDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension" + } + } + }, + "description": "The JSON representation of the EvaluationRubricDimension resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationRubricDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81429,6 +100937,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EventCircumstanceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EventCircumstanceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EventCircumstanceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -81545,7 +101114,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81588,7 +101157,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81608,27 +101177,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/eventCircumstanceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteEventCircumstancesById", + "/ed-fi/eventCircumstanceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEventCircumstancesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -81642,48 +101224,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "eventCircumstanceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eventCircumstanceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getEventCircumstancesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEventCircumstancesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -81691,14 +101262,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -81710,20 +101281,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "eventCircumstanceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putEventCircumstance", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/eventCircumstanceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteEventCircumstancesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -81738,18 +101313,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor" - } - } - }, - "description": "The JSON representation of the EventCircumstance resource to be created or updated.", - "required": true, - "x-bodyName": "EventCircumstance" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -81767,7 +101330,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "eventCircumstanceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getEventCircumstancesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "eventCircumstanceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putEventCircumstance", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor" + } + } + }, + "description": "The JSON representation of the EventCircumstance resource to be created or updated.", + "required": true, + "x-bodyName": "EventCircumstance" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81992,6 +101670,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ExitWithdrawTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -82108,7 +101847,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82151,7 +101890,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82171,27 +101910,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/exitWithdrawTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteExitWithdrawTypesById", + "/ed-fi/exitWithdrawTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getExitWithdrawTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -82205,48 +101957,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "exitWithdrawTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/exitWithdrawTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getExitWithdrawTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getExitWithdrawTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -82254,14 +101995,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -82273,20 +102014,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "exitWithdrawTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putExitWithdrawType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/exitWithdrawTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteExitWithdrawTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -82301,18 +102046,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ExitWithdrawType resource to be created or updated.", - "required": true, - "x-bodyName": "ExitWithdrawType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -82330,7 +102063,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "exitWithdrawTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getExitWithdrawTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "exitWithdrawTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putExitWithdrawType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ExitWithdrawType resource to be created or updated.", + "required": true, + "x-bodyName": "ExitWithdrawType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82634,6 +102482,72 @@ "schoolId" ], "type": "object" + }, + "EdFi_FeederSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FeederSchoolAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "feederSchoolId": { + "format": "int64", + "type": "integer" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "beginDate", + "feederSchoolId", + "schoolId" + ], + "type": "object" + }, + "EdFi_FeederSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -82742,7 +102656,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82785,7 +102699,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82806,27 +102720,40 @@ "EducationOrganization" ] }, - "/ed-fi/feederSchoolAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteFeederSchoolAssociationsById", + "/ed-fi/feederSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFeederSchoolAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -82840,48 +102767,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "feederSchoolAssociations" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/feederSchoolAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getFeederSchoolAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFeederSchoolAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -82889,14 +102806,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -82908,20 +102825,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "feederSchoolAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putFeederSchoolAssociation", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/feederSchoolAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteFeederSchoolAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -82936,18 +102858,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation" - } - } - }, - "description": "The JSON representation of the FeederSchoolAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "FeederSchoolAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -82965,7 +102875,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "feederSchoolAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getFeederSchoolAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "feederSchoolAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putFeederSchoolAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation" + } + } + }, + "description": "The JSON representation of the FeederSchoolAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "FeederSchoolAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83193,6 +103218,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_FinancialCollectionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FinancialCollectionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_FinancialCollectionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -83309,7 +103395,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83352,7 +103438,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83372,27 +103458,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/financialCollectionDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteFinancialCollectionsById", + "/ed-fi/financialCollectionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFinancialCollectionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -83406,48 +103505,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "financialCollectionDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/financialCollectionDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getFinancialCollectionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFinancialCollectionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -83455,14 +103543,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -83474,20 +103562,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "financialCollectionDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putFinancialCollection", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/financialCollectionDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteFinancialCollectionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -83502,18 +103594,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor" - } - } - }, - "description": "The JSON representation of the FinancialCollection resource to be created or updated.", - "required": true, - "x-bodyName": "FinancialCollection" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -83531,7 +103611,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "financialCollectionDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getFinancialCollectionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "financialCollectionDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putFinancialCollection", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor" + } + } + }, + "description": "The JSON representation of the FinancialCollection resource to be created or updated.", + "required": true, + "x-bodyName": "FinancialCollection" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83818,6 +104013,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_FunctionDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FunctionDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_FunctionDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -83907,7 +104163,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83950,7 +104206,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83971,27 +104227,40 @@ "Finance" ] }, - "/ed-fi/functionDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteFunctionDimensionsById", + "/ed-fi/functionDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFunctionDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -84005,48 +104274,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "functionDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/functionDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getFunctionDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFunctionDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -84054,14 +104313,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_FunctionDimension" + "items": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -84073,20 +104332,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "functionDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putFunctionDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/functionDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteFunctionDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -84101,18 +104365,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_FunctionDimension" - } - } - }, - "description": "The JSON representation of the FunctionDimension resource to be created or updated.", - "required": true, - "x-bodyName": "FunctionDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -84130,7 +104382,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "functionDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getFunctionDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FunctionDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "functionDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putFunctionDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FunctionDimension" + } + } + }, + "description": "The JSON representation of the FunctionDimension resource to be created or updated.", + "required": true, + "x-bodyName": "FunctionDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84399,6 +104766,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_FundDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FundDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_FundDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -84488,7 +104916,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84531,7 +104959,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84552,27 +104980,40 @@ "Finance" ] }, - "/ed-fi/fundDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteFundDimensionsById", + "/ed-fi/fundDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFundDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -84586,48 +105027,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "fundDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/fundDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getFundDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFundDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -84635,14 +105066,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_FundDimension" + "items": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -84654,20 +105085,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "fundDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putFundDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/fundDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteFundDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -84682,18 +105118,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_FundDimension" - } - } - }, - "description": "The JSON representation of the FundDimension resource to be created or updated.", - "required": true, - "x-bodyName": "FundDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -84711,7 +105135,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "fundDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getFundDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FundDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "fundDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putFundDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_FundDimension" + } + } + }, + "description": "The JSON representation of the FundDimension resource to be created or updated.", + "required": true, + "x-bodyName": "FundDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84918,6 +105457,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradeLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradeLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradeLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -85034,7 +105634,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85077,7 +105677,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85097,27 +105697,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gradeLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradeLevelsById", + "/ed-fi/gradeLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradeLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -85131,48 +105744,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradeLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradeLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradeLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradeLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -85180,14 +105782,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -85199,20 +105801,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradeLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradeLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradeLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradeLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -85227,18 +105833,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor" - } - } - }, - "description": "The JSON representation of the GradeLevel resource to be created or updated.", - "required": true, - "x-bodyName": "GradeLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -85256,7 +105850,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradeLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradeLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradeLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradeLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor" + } + } + }, + "description": "The JSON representation of the GradeLevel resource to be created or updated.", + "required": true, + "x-bodyName": "GradeLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85481,6 +106190,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradePointAverageTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradePointAverageTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -85597,7 +106367,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85640,7 +106410,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85660,27 +106430,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gradePointAverageTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradePointAverageTypesById", + "/ed-fi/gradePointAverageTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradePointAverageTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -85694,48 +106477,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradePointAverageTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradePointAverageTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradePointAverageTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradePointAverageTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -85743,14 +106515,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -85762,20 +106534,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradePointAverageTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradePointAverageType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradePointAverageTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradePointAverageTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -85790,18 +106566,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor" - } - } - }, - "description": "The JSON representation of the GradePointAverageType resource to be created or updated.", - "required": true, - "x-bodyName": "GradePointAverageType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -85819,7 +106583,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradePointAverageTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradePointAverageTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradePointAverageTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradePointAverageType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor" + } + } + }, + "description": "The JSON representation of the GradePointAverageType resource to be created or updated.", + "required": true, + "x-bodyName": "GradePointAverageType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86044,6 +106923,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradeTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradeTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradeTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -86160,7 +107100,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86203,7 +107143,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86223,27 +107163,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gradeTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradeTypesById", + "/ed-fi/gradeTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradeTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -86257,48 +107210,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradeTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradeTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradeTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradeTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -86306,14 +107248,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -86325,20 +107267,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradeTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradeType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradeTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradeTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -86353,18 +107299,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor" - } - } - }, - "description": "The JSON representation of the GradeType resource to be created or updated.", - "required": true, - "x-bodyName": "GradeType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -86382,7 +107316,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradeTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradeTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradeTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradeType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor" + } + } + }, + "description": "The JSON representation of the GradeType resource to be created or updated.", + "required": true, + "x-bodyName": "GradeType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86977,6 +108026,68 @@ "namespace" ], "type": "object" + }, + "EdFi_GradebookEntry_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradebookEntry_TrackedChangeKey": { + "properties": { + "gradebookEntryIdentifier": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "gradebookEntryIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_GradebookEntry_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -87199,7 +108310,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87242,7 +108353,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87264,27 +108375,40 @@ "Gradebook" ] }, - "/ed-fi/gradebookEntries/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradebookEntriesById", + "/ed-fi/gradebookEntries/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -87298,48 +108422,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradebookEntries" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/gradebookEntries/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradebookEntriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -87347,14 +108462,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradebookEntry" + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -87366,20 +108481,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradebookEntries" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradebookEntry", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/gradebookEntries/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradebookEntriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -87394,18 +108515,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradebookEntry" - } - } - }, - "description": "The JSON representation of the GradebookEntry resource to be created or updated.", - "required": true, - "x-bodyName": "GradebookEntry" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -87423,7 +108532,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradebookEntries" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradebookEntriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradebookEntry" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradebookEntries" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradebookEntry", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradebookEntry" + } + } + }, + "description": "The JSON representation of the GradebookEntry resource to be created or updated.", + "required": true, + "x-bodyName": "GradebookEntry" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87717,6 +108941,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradebookEntryTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradebookEntryTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -87833,7 +109118,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87876,7 +109161,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87896,27 +109181,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gradebookEntryTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradebookEntryTypesById", + "/ed-fi/gradebookEntryTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntryTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -87930,48 +109228,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradebookEntryTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradebookEntryTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradebookEntryTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntryTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -87979,14 +109266,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -87998,20 +109285,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradebookEntryTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradebookEntryType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradebookEntryTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradebookEntryTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -88026,18 +109317,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor" - } - } - }, - "description": "The JSON representation of the GradebookEntryType resource to be created or updated.", - "required": true, - "x-bodyName": "GradebookEntryType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -88055,7 +109334,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradebookEntryTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradebookEntryTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradebookEntryTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradebookEntryType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor" + } + } + }, + "description": "The JSON representation of the GradebookEntryType resource to be created or updated.", + "required": true, + "x-bodyName": "GradebookEntryType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -88793,6 +110187,112 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_Grade_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Grade_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "gradeTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "type": "string" + }, + "gradingPeriodSchoolYear": { + "format": "int32", + "type": "integer" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "gradeTypeDescriptor", + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolYear", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_Grade_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -89025,7 +110525,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89068,7 +110568,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89090,27 +110590,40 @@ "ReportCard" ] }, - "/ed-fi/grades/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradesById", + "/ed-fi/grades/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -89124,48 +110637,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "grades" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/grades/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -89173,14 +110677,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Grade" + "items": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -89192,20 +110696,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "grades" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGrade", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/grades/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -89220,18 +110730,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Grade" - } - } - }, - "description": "The JSON representation of the Grade resource to be created or updated.", - "required": true, - "x-bodyName": "Grade" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -89249,7 +110747,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "grades" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Grade" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "grades" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGrade", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Grade" + } + } + }, + "description": "The JSON representation of the Grade resource to be created or updated.", + "required": true, + "x-bodyName": "Grade" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89558,6 +111171,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradingPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradingPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradingPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -89674,7 +111348,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89717,7 +111391,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89737,27 +111411,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gradingPeriodDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradingPeriodsById", + "/ed-fi/gradingPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -89771,48 +111458,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradingPeriodDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradingPeriodDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradingPeriodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -89820,14 +111496,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -89839,20 +111515,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradingPeriodDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradingPeriod", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gradingPeriodDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradingPeriodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -89867,18 +111547,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor" - } - } - }, - "description": "The JSON representation of the GradingPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "GradingPeriod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -89896,7 +111564,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradingPeriodDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradingPeriodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradingPeriodDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradingPeriod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor" + } + } + }, + "description": "The JSON representation of the GradingPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "GradingPeriod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90280,6 +112063,77 @@ "schoolYear" ], "type": "object" + }, + "EdFi_GradingPeriod_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradingPeriod_TrackedChangeKey": { + "properties": { + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "gradingPeriodDescriptor", + "gradingPeriodName", + "schoolId", + "schoolYear" + ], + "type": "object" + }, + "EdFi_GradingPeriod_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -90416,7 +112270,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90459,7 +112313,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90482,27 +112336,40 @@ "ReportCard" ] }, - "/ed-fi/gradingPeriods/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGradingPeriodsById", + "/ed-fi/gradingPeriods/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -90516,48 +112383,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gradingPeriods" ] }, + "x-Ed-Fi-domains": [ + "SchoolCalendar", + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/gradingPeriods/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGradingPeriodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -90565,14 +112424,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GradingPeriod" + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -90584,20 +112443,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gradingPeriods" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGradingPeriod", + "x-Ed-Fi-domains": [ + "SchoolCalendar", + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/gradingPeriods/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGradingPeriodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -90612,18 +112478,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GradingPeriod" - } - } - }, - "description": "The JSON representation of the GradingPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "GradingPeriod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -90641,7 +112495,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gradingPeriods" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGradingPeriodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradingPeriod" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gradingPeriods" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGradingPeriod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GradingPeriod" + } + } + }, + "description": "The JSON representation of the GradingPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "GradingPeriod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90884,6 +112853,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GraduationPlanTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GraduationPlanTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -91000,7 +113030,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91043,7 +113073,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -91063,27 +113093,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/graduationPlanTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGraduationPlanTypesById", + "/ed-fi/graduationPlanTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlanTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -91097,48 +113140,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "graduationPlanTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/graduationPlanTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGraduationPlanTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlanTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -91146,14 +113178,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -91165,20 +113197,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "graduationPlanTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGraduationPlanType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/graduationPlanTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGraduationPlanTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -91193,18 +113229,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor" - } - } - }, - "description": "The JSON representation of the GraduationPlanType resource to be created or updated.", - "required": true, - "x-bodyName": "GraduationPlanType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -91222,7 +113246,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "graduationPlanTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGraduationPlanTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "graduationPlanTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGraduationPlanType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor" + } + } + }, + "description": "The JSON representation of the GraduationPlanType resource to be created or updated.", + "required": true, + "x-bodyName": "GraduationPlanType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92379,6 +114518,72 @@ "assessmentReportingMethodDescriptor" ], "type": "object" + }, + "EdFi_GraduationPlan_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GraduationPlan_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "graduationPlanTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "graduationSchoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "educationOrganizationId", + "graduationPlanTypeDescriptor", + "graduationSchoolYear" + ], + "type": "object" + }, + "EdFi_GraduationPlan_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -92504,7 +114709,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92547,7 +114752,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92569,27 +114774,40 @@ "Graduation" ] }, - "/ed-fi/graduationPlans/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGraduationPlansById", + "/ed-fi/graduationPlans/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlansDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -92603,48 +114821,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "graduationPlans" ] }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation" + ] + }, + "/ed-fi/graduationPlans/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGraduationPlansById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlansKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -92652,14 +114861,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GraduationPlan" + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -92671,20 +114880,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "graduationPlans" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGraduationPlan", + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation" + ] + }, + "/ed-fi/graduationPlans/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGraduationPlansById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -92699,18 +114914,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GraduationPlan" - } - } - }, - "description": "The JSON representation of the GraduationPlan resource to be created or updated.", - "required": true, - "x-bodyName": "GraduationPlan" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -92728,7 +114931,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "graduationPlans" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGraduationPlansById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GraduationPlan" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "graduationPlans" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGraduationPlan", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GraduationPlan" + } + } + }, + "description": "The JSON representation of the GraduationPlan resource to be created or updated.", + "required": true, + "x-bodyName": "GraduationPlan" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92976,6 +115294,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -93092,7 +115471,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93135,7 +115514,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93155,27 +115534,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteGunFreeSchoolsActReportingStatusesById", + "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGunFreeSchoolsActReportingStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -93189,48 +115581,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "gunFreeSchoolsActReportingStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getGunFreeSchoolsActReportingStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGunFreeSchoolsActReportingStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -93238,14 +115619,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -93257,20 +115638,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "gunFreeSchoolsActReportingStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putGunFreeSchoolsActReportingStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteGunFreeSchoolsActReportingStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -93285,18 +115670,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor" - } - } - }, - "description": "The JSON representation of the GunFreeSchoolsActReportingStatus resource to be created or updated.", - "required": true, - "x-bodyName": "GunFreeSchoolsActReportingStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -93314,7 +115687,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "gunFreeSchoolsActReportingStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getGunFreeSchoolsActReportingStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "gunFreeSchoolsActReportingStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putGunFreeSchoolsActReportingStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor" + } + } + }, + "description": "The JSON representation of the GunFreeSchoolsActReportingStatus resource to be created or updated.", + "required": true, + "x-bodyName": "GunFreeSchoolsActReportingStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93539,6 +116027,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -93655,7 +116204,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93698,7 +116247,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93718,27 +116267,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteHomelessPrimaryNighttimeResidencesById", + "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessPrimaryNighttimeResidencesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -93752,48 +116314,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "homelessPrimaryNighttimeResidenceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getHomelessPrimaryNighttimeResidencesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessPrimaryNighttimeResidencesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -93801,14 +116352,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -93820,20 +116371,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "homelessPrimaryNighttimeResidenceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putHomelessPrimaryNighttimeResidence", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteHomelessPrimaryNighttimeResidencesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -93848,18 +116403,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor" - } - } - }, - "description": "The JSON representation of the HomelessPrimaryNighttimeResidence resource to be created or updated.", - "required": true, - "x-bodyName": "HomelessPrimaryNighttimeResidence" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -93877,7 +116420,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "homelessPrimaryNighttimeResidenceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getHomelessPrimaryNighttimeResidencesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "homelessPrimaryNighttimeResidenceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putHomelessPrimaryNighttimeResidence", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor" + } + } + }, + "description": "The JSON representation of the HomelessPrimaryNighttimeResidence resource to be created or updated.", + "required": true, + "x-bodyName": "HomelessPrimaryNighttimeResidence" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94102,6 +116760,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_HomelessProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_HomelessProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -94218,7 +116937,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94261,7 +116980,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94281,27 +117000,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/homelessProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteHomelessProgramServicesById", + "/ed-fi/homelessProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -94315,48 +117047,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "homelessProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/homelessProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getHomelessProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -94364,14 +117085,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -94383,20 +117104,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "homelessProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putHomelessProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/homelessProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteHomelessProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -94411,18 +117136,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the HomelessProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "HomelessProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -94440,7 +117153,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "homelessProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getHomelessProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "homelessProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putHomelessProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the HomelessProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "HomelessProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94665,6 +117493,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IdeaPartDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IdeaPartDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IdeaPartDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -94781,7 +117670,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94824,7 +117713,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94844,27 +117733,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/ideaPartDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIDEAPartsById", + "/ed-fi/ideaPartDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIDEAPartsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -94878,48 +117780,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "ideaPartDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ideaPartDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIDEAPartsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIDEAPartsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -94927,14 +117818,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -94946,20 +117837,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "ideaPartDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIDEAPart", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ideaPartDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIDEAPartsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -94974,18 +117869,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor" - } - } - }, - "description": "The JSON representation of the IDEAPart resource to be created or updated.", - "required": true, - "x-bodyName": "IDEAPart" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -95003,7 +117886,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "ideaPartDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIDEAPartsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "ideaPartDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIDEAPart", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor" + } + } + }, + "description": "The JSON representation of the IDEAPart resource to be created or updated.", + "required": true, + "x-bodyName": "IDEAPart" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95228,6 +118226,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IdentificationDocumentUseDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -95344,7 +118403,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95387,7 +118446,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95407,27 +118466,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/identificationDocumentUseDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIdentificationDocumentUsesById", + "/ed-fi/identificationDocumentUseDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIdentificationDocumentUsesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -95441,48 +118513,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "identificationDocumentUseDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/identificationDocumentUseDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIdentificationDocumentUsesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIdentificationDocumentUsesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -95490,14 +118551,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -95509,20 +118570,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "identificationDocumentUseDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIdentificationDocumentUse", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/identificationDocumentUseDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIdentificationDocumentUsesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -95537,18 +118602,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor" - } - } - }, - "description": "The JSON representation of the IdentificationDocumentUse resource to be created or updated.", - "required": true, - "x-bodyName": "IdentificationDocumentUse" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -95566,7 +118619,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "identificationDocumentUseDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIdentificationDocumentUsesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "identificationDocumentUseDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIdentificationDocumentUse", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor" + } + } + }, + "description": "The JSON representation of the IdentificationDocumentUse resource to be created or updated.", + "required": true, + "x-bodyName": "IdentificationDocumentUse" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95791,6 +118959,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ImmunizationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ImmunizationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ImmunizationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -95907,7 +119136,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95950,7 +119179,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95970,27 +119199,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/immunizationTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteImmunizationTypesById", + "/ed-fi/immunizationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getImmunizationTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -96004,48 +119246,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "immunizationTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/immunizationTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getImmunizationTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getImmunizationTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -96053,14 +119284,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -96072,20 +119303,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "immunizationTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putImmunizationType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/immunizationTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteImmunizationTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -96100,18 +119335,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ImmunizationType resource to be created or updated.", - "required": true, - "x-bodyName": "ImmunizationType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -96129,7 +119352,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "immunizationTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getImmunizationTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "immunizationTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putImmunizationType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ImmunizationType resource to be created or updated.", + "required": true, + "x-bodyName": "ImmunizationType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96354,6 +119692,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IncidentLocationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IncidentLocationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IncidentLocationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -96470,7 +119869,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -96513,7 +119912,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96533,27 +119932,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/incidentLocationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIncidentLocationsById", + "/ed-fi/incidentLocationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIncidentLocationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -96567,48 +119979,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "incidentLocationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/incidentLocationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIncidentLocationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIncidentLocationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -96616,14 +120017,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -96635,20 +120036,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "incidentLocationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIncidentLocation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/incidentLocationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIncidentLocationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -96663,18 +120068,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor" - } - } - }, - "description": "The JSON representation of the IncidentLocation resource to be created or updated.", - "required": true, - "x-bodyName": "IncidentLocation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -96692,7 +120085,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "incidentLocationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIncidentLocationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "incidentLocationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIncidentLocation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor" + } + } + }, + "description": "The JSON representation of the IncidentLocation resource to be created or updated.", + "required": true, + "x-bodyName": "IncidentLocation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96917,6 +120425,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IndicatorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IndicatorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IndicatorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -97033,7 +120602,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97076,7 +120645,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -97096,27 +120665,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/indicatorDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIndicatorsById", + "/ed-fi/indicatorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -97130,48 +120712,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "indicatorDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIndicatorsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -97179,14 +120750,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -97198,20 +120769,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "indicatorDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIndicator", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIndicatorsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -97226,18 +120801,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorDescriptor" - } - } - }, - "description": "The JSON representation of the Indicator resource to be created or updated.", - "required": true, - "x-bodyName": "Indicator" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -97255,7 +120818,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "indicatorDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIndicatorsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "indicatorDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIndicator", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor" + } + } + }, + "description": "The JSON representation of the Indicator resource to be created or updated.", + "required": true, + "x-bodyName": "Indicator" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -97480,6 +121158,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IndicatorGroupDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IndicatorGroupDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IndicatorGroupDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -97596,7 +121335,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97639,7 +121378,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -97659,27 +121398,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/indicatorGroupDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIndicatorGroupsById", + "/ed-fi/indicatorGroupDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorGroupsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -97693,48 +121445,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "indicatorGroupDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorGroupDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIndicatorGroupsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorGroupsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -97742,14 +121483,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -97761,20 +121502,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "indicatorGroupDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIndicatorGroup", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorGroupDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIndicatorGroupsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -97789,18 +121534,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor" - } - } - }, - "description": "The JSON representation of the IndicatorGroup resource to be created or updated.", - "required": true, - "x-bodyName": "IndicatorGroup" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -97818,7 +121551,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "indicatorGroupDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIndicatorGroupsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "indicatorGroupDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIndicatorGroup", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor" + } + } + }, + "description": "The JSON representation of the IndicatorGroup resource to be created or updated.", + "required": true, + "x-bodyName": "IndicatorGroup" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98043,6 +121891,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IndicatorLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IndicatorLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IndicatorLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -98159,7 +122068,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98202,7 +122111,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98222,27 +122131,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/indicatorLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteIndicatorLevelsById", + "/ed-fi/indicatorLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -98256,48 +122178,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "indicatorLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getIndicatorLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -98305,14 +122216,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -98324,20 +122235,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "indicatorLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIndicatorLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/indicatorLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteIndicatorLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -98352,18 +122267,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor" - } - } - }, - "description": "The JSON representation of the IndicatorLevel resource to be created or updated.", - "required": true, - "x-bodyName": "IndicatorLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -98381,7 +122284,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "indicatorLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getIndicatorLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "indicatorLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIndicatorLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor" + } + } + }, + "description": "The JSON representation of the IndicatorLevel resource to be created or updated.", + "required": true, + "x-bodyName": "IndicatorLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98606,6 +122624,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -98722,7 +122801,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98765,7 +122844,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98785,27 +122864,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/institutionTelephoneNumberTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInstitutionTelephoneNumberTypesById", + "/ed-fi/institutionTelephoneNumberTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInstitutionTelephoneNumberTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -98819,48 +122911,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "institutionTelephoneNumberTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/institutionTelephoneNumberTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInstitutionTelephoneNumberTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInstitutionTelephoneNumberTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -98868,14 +122949,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -98887,20 +122968,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "institutionTelephoneNumberTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInstitutionTelephoneNumberType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/institutionTelephoneNumberTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInstitutionTelephoneNumberTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -98915,18 +123000,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor" - } - } - }, - "description": "The JSON representation of the InstitutionTelephoneNumberType resource to be created or updated.", - "required": true, - "x-bodyName": "InstitutionTelephoneNumberType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -98944,7 +123017,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "institutionTelephoneNumberTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInstitutionTelephoneNumberTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "institutionTelephoneNumberTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInstitutionTelephoneNumberType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor" + } + } + }, + "description": "The JSON representation of the InstitutionTelephoneNumberType resource to be created or updated.", + "required": true, + "x-bodyName": "InstitutionTelephoneNumberType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -99169,6 +123357,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InteractivityStyleDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InteractivityStyleDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InteractivityStyleDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -99285,7 +123534,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99328,7 +123577,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -99348,27 +123597,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/interactivityStyleDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInteractivityStylesById", + "/ed-fi/interactivityStyleDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInteractivityStylesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -99382,48 +123644,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interactivityStyleDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interactivityStyleDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInteractivityStylesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInteractivityStylesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -99431,14 +123682,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -99450,20 +123701,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interactivityStyleDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInteractivityStyle", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interactivityStyleDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInteractivityStylesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -99478,18 +123733,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor" - } - } - }, - "description": "The JSON representation of the InteractivityStyle resource to be created or updated.", - "required": true, - "x-bodyName": "InteractivityStyle" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -99507,7 +123750,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interactivityStyleDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInteractivityStylesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interactivityStyleDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInteractivityStyle", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor" + } + } + }, + "description": "The JSON representation of the InteractivityStyle resource to be created or updated.", + "required": true, + "x-bodyName": "InteractivityStyle" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -99732,6 +124090,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InternetAccessDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InternetAccessDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InternetAccessDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -99848,7 +124267,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99891,7 +124310,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -99911,27 +124330,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/internetAccessDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInternetAccessesById", + "/ed-fi/internetAccessDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -99945,48 +124377,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "internetAccessDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetAccessDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInternetAccessesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -99994,14 +124415,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -100013,20 +124434,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "internetAccessDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInternetAccess", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetAccessDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInternetAccessesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -100041,18 +124466,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor" - } - } - }, - "description": "The JSON representation of the InternetAccess resource to be created or updated.", - "required": true, - "x-bodyName": "InternetAccess" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -100070,7 +124483,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "internetAccessDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInternetAccessesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "internetAccessDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInternetAccess", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor" + } + } + }, + "description": "The JSON representation of the InternetAccess resource to be created or updated.", + "required": true, + "x-bodyName": "InternetAccess" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100295,6 +124823,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -100411,7 +125000,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100454,7 +125043,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100474,27 +125063,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/internetAccessTypeInResidenceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInternetAccessTypeInResidencesById", + "/ed-fi/internetAccessTypeInResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessTypeInResidencesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -100508,48 +125110,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "internetAccessTypeInResidenceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetAccessTypeInResidenceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInternetAccessTypeInResidencesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessTypeInResidencesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -100557,14 +125148,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -100576,20 +125167,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "internetAccessTypeInResidenceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInternetAccessTypeInResidence", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetAccessTypeInResidenceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInternetAccessTypeInResidencesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -100604,18 +125199,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor" - } - } - }, - "description": "The JSON representation of the InternetAccessTypeInResidence resource to be created or updated.", - "required": true, - "x-bodyName": "InternetAccessTypeInResidence" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -100633,7 +125216,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "internetAccessTypeInResidenceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInternetAccessTypeInResidencesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "internetAccessTypeInResidenceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInternetAccessTypeInResidence", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor" + } + } + }, + "description": "The JSON representation of the InternetAccessTypeInResidence resource to be created or updated.", + "required": true, + "x-bodyName": "InternetAccessTypeInResidence" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100858,6 +125556,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -100974,7 +125733,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -101017,7 +125776,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -101037,27 +125796,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/internetPerformanceInResidenceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInternetPerformanceInResidencesById", + "/ed-fi/internetPerformanceInResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInternetPerformanceInResidencesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -101071,48 +125843,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "internetPerformanceInResidenceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetPerformanceInResidenceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInternetPerformanceInResidencesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInternetPerformanceInResidencesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -101120,14 +125881,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -101139,20 +125900,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "internetPerformanceInResidenceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInternetPerformanceInResidence", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/internetPerformanceInResidenceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInternetPerformanceInResidencesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -101167,18 +125932,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor" - } - } - }, - "description": "The JSON representation of the InternetPerformanceInResidence resource to be created or updated.", - "required": true, - "x-bodyName": "InternetPerformanceInResidence" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -101196,7 +125949,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "internetPerformanceInResidenceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInternetPerformanceInResidencesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "internetPerformanceInResidenceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInternetPerformanceInResidence", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor" + } + } + }, + "description": "The JSON representation of the InternetPerformanceInResidence resource to be created or updated.", + "required": true, + "x-bodyName": "InternetPerformanceInResidence" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -101421,6 +126289,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InterventionClassDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionClassDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InterventionClassDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -101537,7 +126466,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -101580,7 +126509,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -101600,27 +126529,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/interventionClassDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInterventionClassesById", + "/ed-fi/interventionClassDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionClassesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -101634,48 +126576,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interventionClassDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interventionClassDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInterventionClassesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionClassesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -101683,14 +126614,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -101702,20 +126633,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interventionClassDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInterventionClass", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interventionClassDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInterventionClassesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -101730,18 +126665,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor" - } - } - }, - "description": "The JSON representation of the InterventionClass resource to be created or updated.", - "required": true, - "x-bodyName": "InterventionClass" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -101759,7 +126682,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interventionClassDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInterventionClassesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interventionClassDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInterventionClass", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor" + } + } + }, + "description": "The JSON representation of the InterventionClass resource to be created or updated.", + "required": true, + "x-bodyName": "InterventionClass" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -101984,6 +127022,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -102100,7 +127199,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102143,7 +127242,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -102163,27 +127262,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/interventionEffectivenessRatingDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInterventionEffectivenessRatingsById", + "/ed-fi/interventionEffectivenessRatingDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionEffectivenessRatingsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -102197,48 +127309,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interventionEffectivenessRatingDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interventionEffectivenessRatingDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInterventionEffectivenessRatingsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionEffectivenessRatingsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -102246,14 +127347,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -102265,20 +127366,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interventionEffectivenessRatingDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInterventionEffectivenessRating", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interventionEffectivenessRatingDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInterventionEffectivenessRatingsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -102293,18 +127398,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor" - } - } - }, - "description": "The JSON representation of the InterventionEffectivenessRating resource to be created or updated.", - "required": true, - "x-bodyName": "InterventionEffectivenessRating" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -102322,7 +127415,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interventionEffectivenessRatingDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInterventionEffectivenessRatingsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interventionEffectivenessRatingDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInterventionEffectivenessRating", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor" + } + } + }, + "description": "The JSON representation of the InterventionEffectivenessRating resource to be created or updated.", + "required": true, + "x-bodyName": "InterventionEffectivenessRating" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -103034,6 +128242,67 @@ "interventionPrescriptionIdentificationCode" ], "type": "object" + }, + "EdFi_InterventionPrescription_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionPrescription_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionPrescriptionIdentificationCode": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ], + "type": "object" + }, + "EdFi_InterventionPrescription_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -103160,7 +128429,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -103203,7 +128472,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -103224,27 +128493,40 @@ "Intervention" ] }, - "/ed-fi/interventionPrescriptions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInterventionPrescriptionsById", + "/ed-fi/interventionPrescriptions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionPrescriptionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -103258,48 +128540,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interventionPrescriptions" ] }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/interventionPrescriptions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInterventionPrescriptionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionPrescriptionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -103307,14 +128579,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InterventionPrescription" + "items": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -103326,20 +128598,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interventionPrescriptions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInterventionPrescription", + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/interventionPrescriptions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInterventionPrescriptionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -103354,18 +128631,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InterventionPrescription" - } - } - }, - "description": "The JSON representation of the InterventionPrescription resource to be created or updated.", - "required": true, - "x-bodyName": "InterventionPrescription" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -103383,7 +128648,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interventionPrescriptions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInterventionPrescriptionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interventionPrescriptions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInterventionPrescription", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription" + } + } + }, + "description": "The JSON representation of the InterventionPrescription resource to be created or updated.", + "required": true, + "x-bodyName": "InterventionPrescription" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -104253,6 +129633,67 @@ "stateAbbreviationDescriptor" ], "type": "object" + }, + "EdFi_InterventionStudy_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionStudy_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionStudyIdentificationCode": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionStudyIdentificationCode" + ], + "type": "object" + }, + "EdFi_InterventionStudy_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -104380,7 +129821,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104423,7 +129864,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -104444,27 +129885,40 @@ "Intervention" ] }, - "/ed-fi/interventionStudies/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInterventionStudiesById", + "/ed-fi/interventionStudies/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionStudiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -104478,48 +129932,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interventionStudies" ] }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/interventionStudies/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInterventionStudiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionStudiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -104527,14 +129971,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_InterventionStudy" + "items": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -104546,20 +129990,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interventionStudies" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putInterventionStudy", + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/interventionStudies/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInterventionStudiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -104574,18 +130023,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_InterventionStudy" - } - } - }, - "description": "The JSON representation of the InterventionStudy resource to be created or updated.", - "required": true, - "x-bodyName": "InterventionStudy" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -104603,7 +130040,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interventionStudies" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInterventionStudiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionStudy" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interventionStudies" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putInterventionStudy", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_InterventionStudy" + } + } + }, + "description": "The JSON representation of the InterventionStudy resource to be created or updated.", + "required": true, + "x-bodyName": "InterventionStudy" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -105580,6 +131132,67 @@ "staffReference" ], "type": "object" + }, + "EdFi_Intervention_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Intervention_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionIdentificationCode": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionIdentificationCode" + ], + "type": "object" + }, + "EdFi_Intervention_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -105724,7 +131337,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -105767,7 +131380,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -105789,27 +131402,40 @@ "StudentCohort" ] }, - "/ed-fi/interventions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteInterventionsById", + "/ed-fi/interventions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -105823,48 +131449,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "interventions" ] }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/interventions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getInterventionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -105872,14 +131489,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Intervention" + "items": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -105891,20 +131508,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "interventions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putIntervention", + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/interventions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteInterventionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -105919,18 +131542,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Intervention" - } - } - }, - "description": "The JSON representation of the Intervention resource to be created or updated.", - "required": true, - "x-bodyName": "Intervention" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -105948,7 +131559,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "interventions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getInterventionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Intervention" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "interventions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putIntervention", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Intervention" + } + } + }, + "description": "The JSON representation of the Intervention resource to be created or updated.", + "required": true, + "x-bodyName": "Intervention" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106201,6 +131927,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LanguageDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LanguageDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LanguageDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -106317,7 +132104,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106360,7 +132147,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106380,27 +132167,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/languageDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLanguagesById", + "/ed-fi/languageDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLanguagesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -106414,48 +132214,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "languageDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLanguagesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLanguagesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -106463,14 +132252,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LanguageDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -106482,20 +132271,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "languageDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLanguage", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLanguagesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -106510,18 +132303,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LanguageDescriptor" - } - } - }, - "description": "The JSON representation of the Language resource to be created or updated.", - "required": true, - "x-bodyName": "Language" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -106539,7 +132320,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "languageDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLanguagesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "languageDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLanguage", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor" + } + } + }, + "description": "The JSON representation of the Language resource to be created or updated.", + "required": true, + "x-bodyName": "Language" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106764,6 +132660,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -106880,7 +132837,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106923,7 +132880,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106943,27 +132900,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/languageInstructionProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLanguageInstructionProgramServicesById", + "/ed-fi/languageInstructionProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageInstructionProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -106977,48 +132947,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "languageInstructionProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageInstructionProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLanguageInstructionProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageInstructionProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -107026,14 +132985,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -107045,20 +133004,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "languageInstructionProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLanguageInstructionProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageInstructionProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLanguageInstructionProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -107073,18 +133036,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the LanguageInstructionProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "LanguageInstructionProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -107102,7 +133053,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "languageInstructionProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLanguageInstructionProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "languageInstructionProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLanguageInstructionProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the LanguageInstructionProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "LanguageInstructionProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107327,6 +133393,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LanguageUseDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LanguageUseDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LanguageUseDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -107443,7 +133570,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107486,7 +133613,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107506,27 +133633,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/languageUseDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLanguageUsesById", + "/ed-fi/languageUseDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageUsesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -107540,48 +133680,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "languageUseDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageUseDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLanguageUsesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageUsesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -107589,14 +133718,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -107608,20 +133737,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "languageUseDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLanguageUse", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/languageUseDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLanguageUsesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -107636,18 +133769,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor" - } - } - }, - "description": "The JSON representation of the LanguageUse resource to be created or updated.", - "required": true, - "x-bodyName": "LanguageUse" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -107665,7 +133786,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "languageUseDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLanguageUsesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "languageUseDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLanguageUse", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor" + } + } + }, + "description": "The JSON representation of the LanguageUse resource to be created or updated.", + "required": true, + "x-bodyName": "LanguageUse" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107890,6 +134126,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LearningStandardCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LearningStandardCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -108006,7 +134303,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108049,7 +134346,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108069,27 +134366,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/learningStandardCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLearningStandardCategoriesById", + "/ed-fi/learningStandardCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -108103,48 +134413,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "learningStandardCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLearningStandardCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -108152,14 +134451,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -108171,20 +134470,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "learningStandardCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLearningStandardCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLearningStandardCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -108199,18 +134502,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the LearningStandardCategory resource to be created or updated.", - "required": true, - "x-bodyName": "LearningStandardCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -108228,7 +134519,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "learningStandardCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLearningStandardCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "learningStandardCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLearningStandardCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the LearningStandardCategory resource to be created or updated.", + "required": true, + "x-bodyName": "LearningStandardCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108555,6 +134961,73 @@ "targetLearningStandardId" ], "type": "object" + }, + "EdFi_LearningStandardEquivalenceAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "sourceLearningStandardId": { + "maxLength": 60, + "type": "string" + }, + "targetLearningStandardId": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "namespace", + "sourceLearningStandardId", + "targetLearningStandardId" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -108673,7 +135146,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108716,7 +135189,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108736,27 +135209,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/learningStandardEquivalenceAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLearningStandardEquivalenceAssociationsById", + "/ed-fi/learningStandardEquivalenceAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -108770,48 +135256,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "learningStandardEquivalenceAssociations" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardEquivalenceAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLearningStandardEquivalenceAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -108819,14 +135294,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -108838,20 +135313,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "learningStandardEquivalenceAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLearningStandardEquivalenceAssociation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardEquivalenceAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLearningStandardEquivalenceAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -108866,18 +135345,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation" - } - } - }, - "description": "The JSON representation of the LearningStandardEquivalenceAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "LearningStandardEquivalenceAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -108895,7 +135362,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "learningStandardEquivalenceAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLearningStandardEquivalenceAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "learningStandardEquivalenceAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLearningStandardEquivalenceAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation" + } + } + }, + "description": "The JSON representation of the LearningStandardEquivalenceAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "LearningStandardEquivalenceAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109126,6 +135708,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -109242,7 +135885,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109285,7 +135928,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109305,27 +135948,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/learningStandardEquivalenceStrengthDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLearningStandardEquivalenceStrengthsById", + "/ed-fi/learningStandardEquivalenceStrengthDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceStrengthsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -109339,48 +135995,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "learningStandardEquivalenceStrengthDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardEquivalenceStrengthDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLearningStandardEquivalenceStrengthsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceStrengthsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -109388,14 +136033,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -109407,20 +136052,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "learningStandardEquivalenceStrengthDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLearningStandardEquivalenceStrength", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardEquivalenceStrengthDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLearningStandardEquivalenceStrengthsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -109435,18 +136084,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor" - } - } - }, - "description": "The JSON representation of the LearningStandardEquivalenceStrength resource to be created or updated.", - "required": true, - "x-bodyName": "LearningStandardEquivalenceStrength" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -109464,7 +136101,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "learningStandardEquivalenceStrengthDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLearningStandardEquivalenceStrengthsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "learningStandardEquivalenceStrengthDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLearningStandardEquivalenceStrength", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor" + } + } + }, + "description": "The JSON representation of the LearningStandardEquivalenceStrength resource to be created or updated.", + "required": true, + "x-bodyName": "LearningStandardEquivalenceStrength" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109689,6 +136441,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LearningStandardScopeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardScopeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LearningStandardScopeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -109805,7 +136618,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109848,7 +136661,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109868,27 +136681,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/learningStandardScopeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLearningStandardScopesById", + "/ed-fi/learningStandardScopeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardScopesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -109902,48 +136728,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "learningStandardScopeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardScopeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLearningStandardScopesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardScopesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -109951,14 +136766,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -109970,20 +136785,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "learningStandardScopeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLearningStandardScope", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/learningStandardScopeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLearningStandardScopesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -109998,18 +136817,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor" - } - } - }, - "description": "The JSON representation of the LearningStandardScope resource to be created or updated.", - "required": true, - "x-bodyName": "LearningStandardScope" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -110027,7 +136834,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "learningStandardScopeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLearningStandardScopesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "learningStandardScopeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLearningStandardScope", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor" + } + } + }, + "description": "The JSON representation of the LearningStandardScope resource to be created or updated.", + "required": true, + "x-bodyName": "LearningStandardScope" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -110849,6 +137771,62 @@ "learningStandardId" ], "type": "object" + }, + "EdFi_LearningStandard_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandard_TrackedChangeKey": { + "properties": { + "learningStandardId": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "learningStandardId" + ], + "type": "object" + }, + "EdFi_LearningStandard_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -111003,7 +137981,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111046,7 +138024,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111073,27 +138051,40 @@ "Standards" ] }, - "/ed-fi/learningStandards/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLearningStandardsById", + "/ed-fi/learningStandards/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -111107,48 +138098,44 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "learningStandards" ] }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, + "/ed-fi/learningStandards/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLearningStandardsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -111156,14 +138143,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandard" + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -111175,20 +138162,31 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "learningStandards" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLearningStandard", + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, + "/ed-fi/learningStandards/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLearningStandardsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -111203,18 +138201,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LearningStandard" - } - } - }, - "description": "The JSON representation of the LearningStandard resource to be created or updated.", - "required": true, - "x-bodyName": "LearningStandard" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -111232,7 +138218,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "learningStandards" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLearningStandardsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandard" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "learningStandards" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLearningStandard", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LearningStandard" + } + } + }, + "description": "The JSON representation of the LearningStandard resource to be created or updated.", + "required": true, + "x-bodyName": "LearningStandard" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111495,6 +138596,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LevelOfEducationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LevelOfEducationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LevelOfEducationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -111611,7 +138773,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111654,7 +138816,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111674,27 +138836,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/levelOfEducationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLevelOfEducationsById", + "/ed-fi/levelOfEducationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLevelOfEducationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -111708,48 +138883,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "levelOfEducationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/levelOfEducationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLevelOfEducationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLevelOfEducationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -111757,14 +138921,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -111776,20 +138940,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "levelOfEducationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLevelOfEducation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/levelOfEducationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLevelOfEducationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -111804,18 +138972,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor" - } - } - }, - "description": "The JSON representation of the LevelOfEducation resource to be created or updated.", - "required": true, - "x-bodyName": "LevelOfEducation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -111833,7 +138989,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "levelOfEducationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLevelOfEducationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "levelOfEducationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLevelOfEducation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor" + } + } + }, + "description": "The JSON representation of the LevelOfEducation resource to be created or updated.", + "required": true, + "x-bodyName": "LevelOfEducation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112058,6 +139329,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LicenseStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LicenseStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LicenseStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -112174,7 +139506,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112217,7 +139549,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112237,27 +139569,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/licenseStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLicenseStatusesById", + "/ed-fi/licenseStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -112271,48 +139616,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "licenseStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/licenseStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLicenseStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -112320,14 +139654,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -112339,20 +139673,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "licenseStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLicenseStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/licenseStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLicenseStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -112367,18 +139705,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor" - } - } - }, - "description": "The JSON representation of the LicenseStatus resource to be created or updated.", - "required": true, - "x-bodyName": "LicenseStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -112396,7 +139722,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "licenseStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLicenseStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "licenseStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLicenseStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor" + } + } + }, + "description": "The JSON representation of the LicenseStatus resource to be created or updated.", + "required": true, + "x-bodyName": "LicenseStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112621,6 +140062,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LicenseTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LicenseTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LicenseTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -112737,7 +140239,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112780,7 +140282,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112800,27 +140302,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/licenseTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLicenseTypesById", + "/ed-fi/licenseTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -112834,48 +140349,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "licenseTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/licenseTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLicenseTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -112883,14 +140387,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -112902,20 +140406,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "licenseTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLicenseType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/licenseTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLicenseTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -112930,18 +140438,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor" - } - } - }, - "description": "The JSON representation of the LicenseType resource to be created or updated.", - "required": true, - "x-bodyName": "LicenseType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -112959,7 +140455,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "licenseTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLicenseTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "licenseTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLicenseType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor" + } + } + }, + "description": "The JSON representation of the LicenseType resource to be created or updated.", + "required": true, + "x-bodyName": "LicenseType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -113184,6 +140795,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -113300,7 +140972,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -113343,7 +141015,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -113363,27 +141035,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/limitedEnglishProficiencyDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLimitedEnglishProficienciesById", + "/ed-fi/limitedEnglishProficiencyDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLimitedEnglishProficienciesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -113397,48 +141082,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "limitedEnglishProficiencyDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/limitedEnglishProficiencyDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLimitedEnglishProficienciesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLimitedEnglishProficienciesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -113446,14 +141120,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -113465,20 +141139,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "limitedEnglishProficiencyDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLimitedEnglishProficiency", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/limitedEnglishProficiencyDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLimitedEnglishProficienciesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -113493,18 +141171,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor" - } - } - }, - "description": "The JSON representation of the LimitedEnglishProficiency resource to be created or updated.", - "required": true, - "x-bodyName": "LimitedEnglishProficiency" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -113522,7 +141188,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "limitedEnglishProficiencyDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLimitedEnglishProficienciesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "limitedEnglishProficiencyDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLimitedEnglishProficiency", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor" + } + } + }, + "description": "The JSON representation of the LimitedEnglishProficiency resource to be created or updated.", + "required": true, + "x-bodyName": "LimitedEnglishProficiency" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -113936,6 +141717,72 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_LocalAccount_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalAccount_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalAccount_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -114055,7 +141902,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114098,7 +141945,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -114119,27 +141966,40 @@ "Finance" ] }, - "/ed-fi/localAccounts/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalAccountsById", + "/ed-fi/localAccounts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalAccountsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -114153,48 +142013,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localAccounts" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localAccounts/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalAccountsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalAccountsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -114202,14 +142052,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalAccount" + "items": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -114221,20 +142071,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localAccounts" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalAccount", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localAccounts/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalAccountsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -114249,18 +142104,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalAccount" - } - } - }, - "description": "The JSON representation of the LocalAccount resource to be created or updated.", - "required": true, - "x-bodyName": "LocalAccount" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -114278,7 +142121,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localAccounts" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalAccountsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalAccount" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localAccounts" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalAccount", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalAccount" + } + } + }, + "description": "The JSON representation of the LocalAccount resource to be created or updated.", + "required": true, + "x-bodyName": "LocalAccount" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -114599,6 +142557,77 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_LocalActual_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalActual_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalActual_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -114717,7 +142746,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114760,7 +142789,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -114781,27 +142810,40 @@ "Finance" ] }, - "/ed-fi/localActuals/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalActualsById", + "/ed-fi/localActuals/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalActualsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -114815,48 +142857,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localActuals" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localActuals/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalActualsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalActualsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -114864,14 +142896,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalActual" + "items": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -114883,20 +142915,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localActuals" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalActual", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localActuals/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalActualsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -114911,18 +142948,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalActual" - } - } - }, - "description": "The JSON representation of the LocalActual resource to be created or updated.", - "required": true, - "x-bodyName": "LocalActual" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -114940,7 +142965,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localActuals" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalActualsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalActual" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localActuals" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalActual", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalActual" + } + } + }, + "description": "The JSON representation of the LocalActual resource to be created or updated.", + "required": true, + "x-bodyName": "LocalActual" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -115256,6 +143396,77 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_LocalBudget_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalBudget_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalBudget_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -115374,7 +143585,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -115417,7 +143628,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -115438,27 +143649,40 @@ "Finance" ] }, - "/ed-fi/localBudgets/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalBudgetsById", + "/ed-fi/localBudgets/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalBudgetsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -115472,48 +143696,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localBudgets" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localBudgets/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalBudgetsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalBudgetsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -115521,14 +143735,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalBudget" + "items": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -115540,20 +143754,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localBudgets" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalBudget", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localBudgets/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalBudgetsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -115568,18 +143787,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalBudget" - } - } - }, - "description": "The JSON representation of the LocalBudget resource to be created or updated.", - "required": true, - "x-bodyName": "LocalBudget" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -115597,7 +143804,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localBudgets" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalBudgetsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalBudget" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localBudgets" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalBudget", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalBudget" + } + } + }, + "description": "The JSON representation of the LocalBudget resource to be created or updated.", + "required": true, + "x-bodyName": "LocalBudget" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -115957,6 +144279,82 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_LocalContractedStaff_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalContractedStaff_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_LocalContractedStaff_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -116085,7 +144483,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -116128,7 +144526,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -116149,27 +144547,40 @@ "Finance" ] }, - "/ed-fi/localContractedStaffs/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalContractedStaffsById", + "/ed-fi/localContractedStaffs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalContractedStaffsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -116183,48 +144594,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localContractedStaffs" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localContractedStaffs/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalContractedStaffsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalContractedStaffsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -116232,14 +144633,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalContractedStaff" + "items": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -116251,20 +144652,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localContractedStaffs" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalContractedStaff", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localContractedStaffs/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalContractedStaffsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -116279,18 +144685,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalContractedStaff" - } - } - }, - "description": "The JSON representation of the LocalContractedStaff resource to be created or updated.", - "required": true, - "x-bodyName": "LocalContractedStaff" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -116308,7 +144702,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localContractedStaffs" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalContractedStaffsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localContractedStaffs" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalContractedStaff", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff" + } + } + }, + "description": "The JSON representation of the LocalContractedStaff resource to be created or updated.", + "required": true, + "x-bodyName": "LocalContractedStaff" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118077,6 +146586,62 @@ "localEducationAgencyId" ], "type": "object" + }, + "EdFi_LocalEducationAgency_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalEducationAgency_TrackedChangeKey": { + "properties": { + "localEducationAgencyId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "localEducationAgencyId" + ], + "type": "object" + }, + "EdFi_LocalEducationAgency_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -118232,7 +146797,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118275,7 +146840,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118298,27 +146863,40 @@ "Staff" ] }, - "/ed-fi/localEducationAgencies/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalEducationAgenciesById", + "/ed-fi/localEducationAgencies/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgenciesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -118332,48 +146910,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localEducationAgencies" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, + "/ed-fi/localEducationAgencies/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalEducationAgenciesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgenciesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -118381,14 +146951,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalEducationAgency" + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -118400,20 +146970,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localEducationAgencies" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalEducationAgency", + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, + "/ed-fi/localEducationAgencies/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalEducationAgenciesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -118428,18 +147005,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalEducationAgency" - } - } - }, - "description": "The JSON representation of the LocalEducationAgency resource to be created or updated.", - "required": true, - "x-bodyName": "LocalEducationAgency" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -118457,7 +147022,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localEducationAgencies" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalEducationAgenciesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localEducationAgencies" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalEducationAgency", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency" + } + } + }, + "description": "The JSON representation of the LocalEducationAgency resource to be created or updated.", + "required": true, + "x-bodyName": "LocalEducationAgency" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118726,6 +147406,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -118842,7 +147583,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118885,7 +147626,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118905,27 +147646,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/localEducationAgencyCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalEducationAgencyCategoriesById", + "/ed-fi/localEducationAgencyCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgencyCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -118939,48 +147693,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localEducationAgencyCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/localEducationAgencyCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalEducationAgencyCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgencyCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -118988,14 +147731,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -119007,20 +147750,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localEducationAgencyCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalEducationAgencyCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/localEducationAgencyCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalEducationAgencyCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -119035,18 +147782,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the LocalEducationAgencyCategory resource to be created or updated.", - "required": true, - "x-bodyName": "LocalEducationAgencyCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -119064,7 +147799,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localEducationAgencyCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalEducationAgencyCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localEducationAgencyCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalEducationAgencyCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the LocalEducationAgencyCategory resource to be created or updated.", + "required": true, + "x-bodyName": "LocalEducationAgencyCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119376,6 +148226,77 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_LocalEncumbrance_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalEncumbrance_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalEncumbrance_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -119494,7 +148415,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119537,7 +148458,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119558,27 +148479,40 @@ "Finance" ] }, - "/ed-fi/localEncumbrances/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalEncumbrancesById", + "/ed-fi/localEncumbrances/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEncumbrancesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -119592,48 +148526,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localEncumbrances" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localEncumbrances/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalEncumbrancesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEncumbrancesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -119641,14 +148565,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalEncumbrance" + "items": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -119660,20 +148584,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localEncumbrances" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalEncumbrance", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localEncumbrances/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalEncumbrancesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -119688,18 +148617,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalEncumbrance" - } - } - }, - "description": "The JSON representation of the LocalEncumbrance resource to be created or updated.", - "required": true, - "x-bodyName": "LocalEncumbrance" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -119717,7 +148634,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localEncumbrances" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalEncumbrancesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localEncumbrances" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalEncumbrance", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance" + } + } + }, + "description": "The JSON representation of the LocalEncumbrance resource to be created or updated.", + "required": true, + "x-bodyName": "LocalEncumbrance" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120077,6 +149109,82 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_LocalPayroll_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalPayroll_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_LocalPayroll_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -120205,7 +149313,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120248,7 +149356,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120269,27 +149377,40 @@ "Finance" ] }, - "/ed-fi/localPayrolls/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalPayrollsById", + "/ed-fi/localPayrolls/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalPayrollsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -120303,48 +149424,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localPayrolls" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localPayrolls/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalPayrollsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalPayrollsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -120352,14 +149463,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocalPayroll" + "items": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -120371,20 +149482,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localPayrolls" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocalPayroll", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localPayrolls/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalPayrollsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -120399,18 +149515,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocalPayroll" - } - } - }, - "description": "The JSON representation of the LocalPayroll resource to be created or updated.", - "required": true, - "x-bodyName": "LocalPayroll" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -120428,7 +149532,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localPayrolls" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalPayrollsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalPayroll" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localPayrolls" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocalPayroll", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocalPayroll" + } + } + }, + "description": "The JSON representation of the LocalPayroll resource to be created or updated.", + "required": true, + "x-bodyName": "LocalPayroll" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120664,6 +149883,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LocaleDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocaleDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LocaleDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -120780,7 +150060,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120823,7 +150103,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120843,27 +150123,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/localeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocalesById", + "/ed-fi/localeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -120877,48 +150170,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "localeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/localeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocalesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -120926,14 +150208,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_LocaleDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -120945,20 +150227,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "localeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocale", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/localeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocalesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -120973,18 +150259,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_LocaleDescriptor" - } - } - }, - "description": "The JSON representation of the Locale resource to be created or updated.", - "required": true, - "x-bodyName": "Locale" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -121002,7 +150276,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "localeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocalesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "localeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocale", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor" + } + } + }, + "description": "The JSON representation of the Locale resource to be created or updated.", + "required": true, + "x-bodyName": "Locale" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121264,6 +150653,67 @@ "schoolId" ], "type": "object" + }, + "EdFi_Location_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Location_TrackedChangeKey": { + "properties": { + "classroomIdentificationCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "classroomIdentificationCode", + "schoolId" + ], + "type": "object" + }, + "EdFi_Location_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -121362,7 +150812,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121405,7 +150855,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121427,27 +150877,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/locations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteLocationsById", + "/ed-fi/locations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -121461,48 +150924,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "locations" ] }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/locations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getLocationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -121510,14 +150964,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Location" + "items": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -121529,20 +150983,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "locations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putLocation", + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/locations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteLocationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -121557,18 +151017,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Location" - } - } - }, - "description": "The JSON representation of the Location resource to be created or updated.", - "required": true, - "x-bodyName": "Location" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -121586,7 +151034,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "locations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getLocationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Location" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "locations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putLocation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Location" + } + } + }, + "description": "The JSON representation of the Location resource to be created or updated.", + "required": true, + "x-bodyName": "Location" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121805,6 +151368,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -121921,7 +151545,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121964,7 +151588,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121984,27 +151608,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteMagnetSpecialProgramEmphasisSchoolsById", + "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMagnetSpecialProgramEmphasisSchoolsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -122018,48 +151655,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "magnetSpecialProgramEmphasisSchoolDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getMagnetSpecialProgramEmphasisSchoolsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMagnetSpecialProgramEmphasisSchoolsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -122067,14 +151693,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -122086,20 +151712,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "magnetSpecialProgramEmphasisSchoolDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putMagnetSpecialProgramEmphasisSchool", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteMagnetSpecialProgramEmphasisSchoolsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -122114,18 +151744,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor" - } - } - }, - "description": "The JSON representation of the MagnetSpecialProgramEmphasisSchool resource to be created or updated.", - "required": true, - "x-bodyName": "MagnetSpecialProgramEmphasisSchool" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -122143,7 +151761,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "magnetSpecialProgramEmphasisSchoolDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getMagnetSpecialProgramEmphasisSchoolsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "magnetSpecialProgramEmphasisSchoolDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putMagnetSpecialProgramEmphasisSchool", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor" + } + } + }, + "description": "The JSON representation of the MagnetSpecialProgramEmphasisSchool resource to be created or updated.", + "required": true, + "x-bodyName": "MagnetSpecialProgramEmphasisSchool" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -122368,6 +152101,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MediumOfInstructionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MediumOfInstructionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MediumOfInstructionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -122484,7 +152278,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122527,7 +152321,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -122547,27 +152341,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/mediumOfInstructionDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteMediumOfInstructionsById", + "/ed-fi/mediumOfInstructionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMediumOfInstructionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -122581,48 +152388,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "mediumOfInstructionDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/mediumOfInstructionDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getMediumOfInstructionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMediumOfInstructionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -122630,14 +152426,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -122649,20 +152445,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "mediumOfInstructionDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putMediumOfInstruction", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/mediumOfInstructionDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteMediumOfInstructionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -122677,18 +152477,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor" - } - } - }, - "description": "The JSON representation of the MediumOfInstruction resource to be created or updated.", - "required": true, - "x-bodyName": "MediumOfInstruction" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -122706,7 +152494,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "mediumOfInstructionDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getMediumOfInstructionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "mediumOfInstructionDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putMediumOfInstruction", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor" + } + } + }, + "description": "The JSON representation of the MediumOfInstruction resource to be created or updated.", + "required": true, + "x-bodyName": "MediumOfInstruction" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -122931,6 +152834,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MethodCreditEarnedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MethodCreditEarnedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -123047,7 +153011,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123090,7 +153054,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -123110,27 +153074,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/methodCreditEarnedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteMethodCreditEarnedsById", + "/ed-fi/methodCreditEarnedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMethodCreditEarnedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -123144,48 +153121,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "methodCreditEarnedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/methodCreditEarnedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getMethodCreditEarnedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMethodCreditEarnedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -123193,14 +153159,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -123212,20 +153178,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "methodCreditEarnedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putMethodCreditEarned", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/methodCreditEarnedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteMethodCreditEarnedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -123240,18 +153210,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor" - } - } - }, - "description": "The JSON representation of the MethodCreditEarned resource to be created or updated.", - "required": true, - "x-bodyName": "MethodCreditEarned" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -123269,7 +153227,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "methodCreditEarnedDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getMethodCreditEarnedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "methodCreditEarnedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putMethodCreditEarned", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor" + } + } + }, + "description": "The JSON representation of the MethodCreditEarned resource to be created or updated.", + "required": true, + "x-bodyName": "MethodCreditEarned" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -123494,6 +153567,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -123610,7 +153744,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123653,7 +153787,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -123673,27 +153807,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/migrantEducationProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteMigrantEducationProgramServicesById", + "/ed-fi/migrantEducationProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMigrantEducationProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -123707,48 +153854,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "migrantEducationProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/migrantEducationProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getMigrantEducationProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMigrantEducationProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -123756,14 +153892,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -123775,20 +153911,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "migrantEducationProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putMigrantEducationProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/migrantEducationProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteMigrantEducationProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -123803,18 +153943,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the MigrantEducationProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "MigrantEducationProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -123832,7 +153960,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "migrantEducationProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getMigrantEducationProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "migrantEducationProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putMigrantEducationProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the MigrantEducationProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "MigrantEducationProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124057,6 +154300,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ModelEntityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ModelEntityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ModelEntityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -124173,7 +154477,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124216,7 +154520,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124236,27 +154540,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/modelEntityDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteModelEntitiesById", + "/ed-fi/modelEntityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getModelEntitiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -124270,48 +154587,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "modelEntityDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/modelEntityDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getModelEntitiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getModelEntitiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -124319,14 +154625,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -124338,20 +154644,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "modelEntityDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putModelEntity", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/modelEntityDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteModelEntitiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -124366,18 +154676,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor" - } - } - }, - "description": "The JSON representation of the ModelEntity resource to be created or updated.", - "required": true, - "x-bodyName": "ModelEntity" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -124395,7 +154693,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "modelEntityDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getModelEntitiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "modelEntityDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putModelEntity", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor" + } + } + }, + "description": "The JSON representation of the ModelEntity resource to be created or updated.", + "required": true, + "x-bodyName": "ModelEntity" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124620,6 +155033,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MonitoredDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MonitoredDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MonitoredDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -124736,7 +155210,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124779,7 +155253,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124799,27 +155273,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/monitoredDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteMonitoredsById", + "/ed-fi/monitoredDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMonitoredsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -124833,48 +155320,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "monitoredDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/monitoredDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getMonitoredsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMonitoredsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -124882,14 +155358,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_MonitoredDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -124901,20 +155377,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "monitoredDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putMonitored", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/monitoredDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteMonitoredsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -124929,18 +155409,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_MonitoredDescriptor" - } - } - }, - "description": "The JSON representation of the Monitored resource to be created or updated.", - "required": true, - "x-bodyName": "Monitored" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -124958,7 +155426,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "monitoredDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getMonitoredsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "monitoredDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putMonitored", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor" + } + } + }, + "description": "The JSON representation of the Monitored resource to be created or updated.", + "required": true, + "x-bodyName": "Monitored" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -125183,6 +155766,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -125299,7 +155943,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125342,7 +155986,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -125362,27 +156006,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/neglectedOrDelinquentProgramDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteNeglectedOrDelinquentProgramsById", + "/ed-fi/neglectedOrDelinquentProgramDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -125396,48 +156053,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "neglectedOrDelinquentProgramDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/neglectedOrDelinquentProgramDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getNeglectedOrDelinquentProgramsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -125445,14 +156091,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -125464,20 +156110,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "neglectedOrDelinquentProgramDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putNeglectedOrDelinquentProgram", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/neglectedOrDelinquentProgramDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteNeglectedOrDelinquentProgramsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -125492,18 +156142,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor" - } - } - }, - "description": "The JSON representation of the NeglectedOrDelinquentProgram resource to be created or updated.", - "required": true, - "x-bodyName": "NeglectedOrDelinquentProgram" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -125521,7 +156159,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "neglectedOrDelinquentProgramDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getNeglectedOrDelinquentProgramsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "neglectedOrDelinquentProgramDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putNeglectedOrDelinquentProgram", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor" + } + } + }, + "description": "The JSON representation of the NeglectedOrDelinquentProgram resource to be created or updated.", + "required": true, + "x-bodyName": "NeglectedOrDelinquentProgram" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -125746,6 +156499,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -125862,7 +156676,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125905,7 +156719,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -125925,27 +156739,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteNeglectedOrDelinquentProgramServicesById", + "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -125959,48 +156786,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "neglectedOrDelinquentProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getNeglectedOrDelinquentProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -126008,14 +156824,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -126027,20 +156843,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "neglectedOrDelinquentProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putNeglectedOrDelinquentProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteNeglectedOrDelinquentProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -126055,18 +156875,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the NeglectedOrDelinquentProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "NeglectedOrDelinquentProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -126084,7 +156892,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "neglectedOrDelinquentProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getNeglectedOrDelinquentProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "neglectedOrDelinquentProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putNeglectedOrDelinquentProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the NeglectedOrDelinquentProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "NeglectedOrDelinquentProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126309,6 +157232,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NetworkPurposeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NetworkPurposeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NetworkPurposeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -126425,7 +157409,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126468,7 +157452,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126488,27 +157472,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/networkPurposeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteNetworkPurposesById", + "/ed-fi/networkPurposeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNetworkPurposesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -126522,48 +157519,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "networkPurposeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/networkPurposeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getNetworkPurposesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNetworkPurposesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -126571,14 +157557,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -126590,20 +157576,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "networkPurposeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putNetworkPurpose", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/networkPurposeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteNetworkPurposesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -126618,18 +157608,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor" - } - } - }, - "description": "The JSON representation of the NetworkPurpose resource to be created or updated.", - "required": true, - "x-bodyName": "NetworkPurpose" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -126647,7 +157625,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "networkPurposeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getNetworkPurposesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "networkPurposeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putNetworkPurpose", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor" + } + } + }, + "description": "The JSON representation of the NetworkPurpose resource to be created or updated.", + "required": true, + "x-bodyName": "NetworkPurpose" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126872,6 +157965,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -126988,7 +158142,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127031,7 +158185,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127051,27 +158205,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/nonMedicalImmunizationExemptionDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteNonMedicalImmunizationExemptionsById", + "/ed-fi/nonMedicalImmunizationExemptionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNonMedicalImmunizationExemptionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -127085,48 +158252,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "nonMedicalImmunizationExemptionDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/nonMedicalImmunizationExemptionDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getNonMedicalImmunizationExemptionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNonMedicalImmunizationExemptionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -127134,14 +158290,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -127153,20 +158309,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "nonMedicalImmunizationExemptionDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putNonMedicalImmunizationExemption", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/nonMedicalImmunizationExemptionDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteNonMedicalImmunizationExemptionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -127181,18 +158341,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor" - } - } - }, - "description": "The JSON representation of the NonMedicalImmunizationExemption resource to be created or updated.", - "required": true, - "x-bodyName": "NonMedicalImmunizationExemption" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -127210,7 +158358,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "nonMedicalImmunizationExemptionDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getNonMedicalImmunizationExemptionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "nonMedicalImmunizationExemptionDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putNonMedicalImmunizationExemption", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor" + } + } + }, + "description": "The JSON representation of the NonMedicalImmunizationExemption resource to be created or updated.", + "required": true, + "x-bodyName": "NonMedicalImmunizationExemption" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127497,6 +158760,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ObjectDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ObjectDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ObjectDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -127586,7 +158910,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127629,7 +158953,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127650,27 +158974,40 @@ "Finance" ] }, - "/ed-fi/objectDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteObjectDimensionsById", + "/ed-fi/objectDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getObjectDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -127684,48 +159021,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "objectDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/objectDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getObjectDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getObjectDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -127733,14 +159060,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ObjectDimension" + "items": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -127752,20 +159079,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "objectDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putObjectDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/objectDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteObjectDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -127780,18 +159112,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ObjectDimension" - } - } - }, - "description": "The JSON representation of the ObjectDimension resource to be created or updated.", - "required": true, - "x-bodyName": "ObjectDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -127809,7 +159129,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "objectDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getObjectDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ObjectDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "objectDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putObjectDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ObjectDimension" + } + } + }, + "description": "The JSON representation of the ObjectDimension resource to be created or updated.", + "required": true, + "x-bodyName": "ObjectDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128631,6 +160066,73 @@ "identificationCode" ], "type": "object" + }, + "EdFi_ObjectiveAssessment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ObjectiveAssessment_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "identificationCode": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "identificationCode", + "namespace" + ], + "type": "object" + }, + "EdFi_ObjectiveAssessment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -128777,7 +160279,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128820,7 +160322,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128842,27 +160344,40 @@ "AssessmentMetadata" ] }, - "/ed-fi/objectiveAssessments/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteObjectiveAssessmentsById", + "/ed-fi/objectiveAssessments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getObjectiveAssessmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -128876,48 +160391,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "objectiveAssessments" ] }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/objectiveAssessments/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getObjectiveAssessmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getObjectiveAssessmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -128925,14 +160431,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ObjectiveAssessment" + "items": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -128944,20 +160450,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "objectiveAssessments" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putObjectiveAssessment", + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/objectiveAssessments/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteObjectiveAssessmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -128972,18 +160484,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ObjectiveAssessment" - } - } - }, - "description": "The JSON representation of the ObjectiveAssessment resource to be created or updated.", - "required": true, - "x-bodyName": "ObjectiveAssessment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -129001,7 +160501,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "objectiveAssessments" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getObjectiveAssessmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "objectiveAssessments" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putObjectiveAssessment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment" + } + } + }, + "description": "The JSON representation of the ObjectiveAssessment resource to be created or updated.", + "required": true, + "x-bodyName": "ObjectiveAssessment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129507,6 +161122,67 @@ "requisitionNumber" ], "type": "object" + }, + "EdFi_OpenStaffPosition_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OpenStaffPosition_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "requisitionNumber": { + "maxLength": 20, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "requisitionNumber" + ], + "type": "object" + }, + "EdFi_OpenStaffPosition_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -129650,7 +161326,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129693,7 +161369,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129714,27 +161390,40 @@ "Staff" ] }, - "/ed-fi/openStaffPositions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteOpenStaffPositionsById", + "/ed-fi/openStaffPositions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -129748,48 +161437,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "openStaffPositions" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/openStaffPositions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getOpenStaffPositionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -129797,14 +161476,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_OpenStaffPosition" + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -129816,20 +161495,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "openStaffPositions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putOpenStaffPosition", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/openStaffPositions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteOpenStaffPositionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -129844,18 +161528,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_OpenStaffPosition" - } - } - }, - "description": "The JSON representation of the OpenStaffPosition resource to be created or updated.", - "required": true, - "x-bodyName": "OpenStaffPosition" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -129873,7 +161545,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "openStaffPositions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getOpenStaffPositionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "openStaffPositions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putOpenStaffPosition", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition" + } + } + }, + "description": "The JSON representation of the OpenStaffPosition resource to be created or updated.", + "required": true, + "x-bodyName": "OpenStaffPosition" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130120,6 +161907,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_OperationalStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OperationalStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_OperationalStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -130236,7 +162084,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130279,7 +162127,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130299,27 +162147,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/operationalStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteOperationalStatusesById", + "/ed-fi/operationalStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -130333,48 +162194,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "operationalStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/operationalStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getOperationalStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -130382,14 +162232,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -130401,20 +162251,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "operationalStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putOperationalStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/operationalStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteOperationalStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -130429,18 +162283,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor" - } - } - }, - "description": "The JSON representation of the OperationalStatus resource to be created or updated.", - "required": true, - "x-bodyName": "OperationalStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -130458,7 +162300,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "operationalStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getOperationalStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "operationalStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putOperationalStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor" + } + } + }, + "description": "The JSON representation of the OperationalStatus resource to be created or updated.", + "required": true, + "x-bodyName": "OperationalStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130745,6 +162702,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_OperationalUnitDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OperationalUnitDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_OperationalUnitDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -130834,7 +162852,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130877,7 +162895,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130898,27 +162916,40 @@ "Finance" ] }, - "/ed-fi/operationalUnitDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteOperationalUnitDimensionsById", + "/ed-fi/operationalUnitDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalUnitDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -130932,48 +162963,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "operationalUnitDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/operationalUnitDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getOperationalUnitDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalUnitDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -130981,14 +163002,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_OperationalUnitDimension" + "items": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -131000,20 +163021,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "operationalUnitDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putOperationalUnitDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/operationalUnitDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteOperationalUnitDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -131028,18 +163054,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_OperationalUnitDimension" - } - } - }, - "description": "The JSON representation of the OperationalUnitDimension resource to be created or updated.", - "required": true, - "x-bodyName": "OperationalUnitDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -131057,7 +163071,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "operationalUnitDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getOperationalUnitDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "operationalUnitDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putOperationalUnitDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension" + } + } + }, + "description": "The JSON representation of the OperationalUnitDimension resource to be created or updated.", + "required": true, + "x-bodyName": "OperationalUnitDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132357,6 +164486,62 @@ "organizationDepartmentId" ], "type": "object" + }, + "EdFi_OrganizationDepartment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OrganizationDepartment_TrackedChangeKey": { + "properties": { + "organizationDepartmentId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "organizationDepartmentId" + ], + "type": "object" + }, + "EdFi_OrganizationDepartment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -132483,7 +164668,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132526,7 +164711,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132547,27 +164732,40 @@ "EducationOrganization" ] }, - "/ed-fi/organizationDepartments/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteOrganizationDepartmentsById", + "/ed-fi/organizationDepartments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOrganizationDepartmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -132581,48 +164779,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "organizationDepartments" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/organizationDepartments/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getOrganizationDepartmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOrganizationDepartmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -132630,14 +164818,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_OrganizationDepartment" + "items": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -132649,20 +164837,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "organizationDepartments" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putOrganizationDepartment", + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/organizationDepartments/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteOrganizationDepartmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -132677,18 +164870,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_OrganizationDepartment" - } - } - }, - "description": "The JSON representation of the OrganizationDepartment resource to be created or updated.", - "required": true, - "x-bodyName": "OrganizationDepartment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -132706,7 +164887,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "organizationDepartments" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getOrganizationDepartmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "organizationDepartments" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putOrganizationDepartment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment" + } + } + }, + "description": "The JSON representation of the OrganizationDepartment resource to be created or updated.", + "required": true, + "x-bodyName": "OrganizationDepartment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132953,6 +165249,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_OtherNameTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OtherNameTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_OtherNameTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -133069,7 +165426,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133112,7 +165469,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133132,27 +165489,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/otherNameTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteOtherNameTypesById", + "/ed-fi/otherNameTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOtherNameTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -133166,48 +165536,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "otherNameTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/otherNameTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getOtherNameTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOtherNameTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -133215,14 +165574,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -133234,20 +165593,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "otherNameTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putOtherNameType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/otherNameTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteOtherNameTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -133262,18 +165625,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor" - } - } - }, - "description": "The JSON representation of the OtherNameType resource to be created or updated.", - "required": true, - "x-bodyName": "OtherNameType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -133291,7 +165642,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "otherNameTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getOtherNameTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "otherNameTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putOtherNameType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor" + } + } + }, + "description": "The JSON representation of the OtherNameType resource to be created or updated.", + "required": true, + "x-bodyName": "OtherNameType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133516,6 +165982,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ParticipationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ParticipationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ParticipationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -133632,7 +166159,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133675,7 +166202,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133695,27 +166222,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/participationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteParticipationsById", + "/ed-fi/participationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -133729,48 +166269,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "participationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/participationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getParticipationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -133778,14 +166307,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ParticipationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -133797,20 +166326,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "participationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putParticipation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/participationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteParticipationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -133825,18 +166358,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ParticipationDescriptor" - } - } - }, - "description": "The JSON representation of the Participation resource to be created or updated.", - "required": true, - "x-bodyName": "Participation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -133854,7 +166375,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "participationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getParticipationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "participationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putParticipation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor" + } + } + }, + "description": "The JSON representation of the Participation resource to be created or updated.", + "required": true, + "x-bodyName": "Participation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134079,6 +166715,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ParticipationStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ParticipationStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ParticipationStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -134195,7 +166892,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134238,7 +166935,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134258,27 +166955,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/participationStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteParticipationStatusesById", + "/ed-fi/participationStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -134292,48 +167002,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "participationStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/participationStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getParticipationStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -134341,14 +167040,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -134360,20 +167059,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "participationStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putParticipationStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/participationStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteParticipationStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -134388,18 +167091,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor" - } - } - }, - "description": "The JSON representation of the ParticipationStatus resource to be created or updated.", - "required": true, - "x-bodyName": "ParticipationStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -134417,7 +167108,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "participationStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getParticipationStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "participationStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putParticipationStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor" + } + } + }, + "description": "The JSON representation of the ParticipationStatus resource to be created or updated.", + "required": true, + "x-bodyName": "ParticipationStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134628,6 +167434,67 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "EdFi_Person_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Person_TrackedChangeKey": { + "properties": { + "personId": { + "maxLength": 32, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "personId", + "sourceSystemDescriptor" + ], + "type": "object" + }, + "EdFi_Person_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -134708,7 +167575,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134751,7 +167618,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134773,6 +167640,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/people/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPeopleDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "people" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/people/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPeopleKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "people" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/people/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -134808,7 +167797,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134840,15 +167829,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -134875,7 +167855,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134932,7 +167912,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135134,6 +168114,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PerformanceBaseConversionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -135250,7 +168291,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135293,7 +168334,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135313,6 +168354,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/performanceBaseConversionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceBaseConversionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceBaseConversionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/performanceBaseConversionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceBaseConversionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "performanceBaseConversionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/performanceBaseConversionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -135348,7 +168507,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135380,15 +168539,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -135415,7 +168565,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135472,7 +168622,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135697,6 +168847,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PerformanceLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PerformanceLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -135813,7 +169024,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135856,7 +169067,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135876,27 +169087,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/performanceLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePerformanceLevelsById", + "/ed-fi/performanceLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -135910,48 +169134,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "performanceLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/performanceLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPerformanceLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -135959,14 +169172,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -135978,20 +169191,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "performanceLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPerformanceLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/performanceLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePerformanceLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -136006,18 +169223,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor" - } - } - }, - "description": "The JSON representation of the PerformanceLevel resource to be created or updated.", - "required": true, - "x-bodyName": "PerformanceLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -136035,7 +169240,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "performanceLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPerformanceLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "performanceLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPerformanceLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor" + } + } + }, + "description": "The JSON representation of the PerformanceLevel resource to be created or updated.", + "required": true, + "x-bodyName": "PerformanceLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -136260,6 +169580,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PersonalInformationVerificationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -136376,7 +169757,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136419,7 +169800,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -136439,27 +169820,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/personalInformationVerificationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePersonalInformationVerificationsById", + "/ed-fi/personalInformationVerificationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPersonalInformationVerificationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -136473,48 +169867,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "personalInformationVerificationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/personalInformationVerificationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPersonalInformationVerificationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPersonalInformationVerificationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -136522,14 +169905,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -136541,20 +169924,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "personalInformationVerificationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPersonalInformationVerification", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/personalInformationVerificationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePersonalInformationVerificationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -136569,18 +169956,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor" - } - } - }, - "description": "The JSON representation of the PersonalInformationVerification resource to be created or updated.", - "required": true, - "x-bodyName": "PersonalInformationVerification" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -136598,7 +169973,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "personalInformationVerificationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPersonalInformationVerificationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "personalInformationVerificationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPersonalInformationVerification", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor" + } + } + }, + "description": "The JSON representation of the PersonalInformationVerification resource to be created or updated.", + "required": true, + "x-bodyName": "PersonalInformationVerification" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -136823,6 +170313,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PlatformTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PlatformTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PlatformTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -136939,7 +170490,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136982,7 +170533,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137002,27 +170553,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/platformTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePlatformTypesById", + "/ed-fi/platformTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPlatformTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -137036,48 +170600,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "platformTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/platformTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPlatformTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPlatformTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -137085,14 +170638,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -137104,20 +170657,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "platformTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPlatformType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/platformTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePlatformTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -137132,18 +170689,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor" - } - } - }, - "description": "The JSON representation of the PlatformType resource to be created or updated.", - "required": true, - "x-bodyName": "PlatformType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -137161,7 +170706,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "platformTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPlatformTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "platformTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPlatformType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor" + } + } + }, + "description": "The JSON representation of the PlatformType resource to be created or updated.", + "required": true, + "x-bodyName": "PlatformType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137386,6 +171046,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PopulationServedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PopulationServedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PopulationServedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -137502,7 +171223,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137545,7 +171266,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137565,27 +171286,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/populationServedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePopulationServedsById", + "/ed-fi/populationServedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPopulationServedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -137599,48 +171333,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "populationServedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/populationServedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPopulationServedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPopulationServedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -137648,14 +171371,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -137667,20 +171390,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "populationServedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPopulationServed", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/populationServedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePopulationServedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -137695,18 +171422,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor" - } - } - }, - "description": "The JSON representation of the PopulationServed resource to be created or updated.", - "required": true, - "x-bodyName": "PopulationServed" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -137724,7 +171439,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "populationServedDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPopulationServedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "populationServedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPopulationServed", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor" + } + } + }, + "description": "The JSON representation of the PopulationServed resource to be created or updated.", + "required": true, + "x-bodyName": "PopulationServed" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137949,6 +171779,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -138065,7 +171956,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138108,7 +171999,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138128,27 +172019,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/postSecondaryEventCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePostSecondaryEventCategoriesById", + "/ed-fi/postSecondaryEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -138162,48 +172066,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "postSecondaryEventCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postSecondaryEventCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPostSecondaryEventCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -138211,14 +172104,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -138230,20 +172123,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "postSecondaryEventCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPostSecondaryEventCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postSecondaryEventCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePostSecondaryEventCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -138258,18 +172155,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the PostSecondaryEventCategory resource to be created or updated.", - "required": true, - "x-bodyName": "PostSecondaryEventCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -138287,7 +172172,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "postSecondaryEventCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPostSecondaryEventCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "postSecondaryEventCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPostSecondaryEventCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the PostSecondaryEventCategory resource to be created or updated.", + "required": true, + "x-bodyName": "PostSecondaryEventCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138575,6 +172575,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_PostSecondaryEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryEvent_TrackedChangeKey": { + "properties": { + "eventDate": { + "format": "date", + "type": "string" + }, + "postSecondaryEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "eventDate", + "postSecondaryEventCategoryDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_PostSecondaryEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -138675,7 +172741,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138718,7 +172784,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138739,27 +172805,40 @@ "Graduation" ] }, - "/ed-fi/postSecondaryEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePostSecondaryEventsById", + "/ed-fi/postSecondaryEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -138773,48 +172852,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "postSecondaryEvents" ] }, + "x-Ed-Fi-domains": [ + "Graduation" + ] + }, + "/ed-fi/postSecondaryEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPostSecondaryEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -138822,14 +172891,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryEvent" + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -138841,20 +172910,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "postSecondaryEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPostSecondaryEvent", + "x-Ed-Fi-domains": [ + "Graduation" + ] + }, + "/ed-fi/postSecondaryEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePostSecondaryEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -138869,18 +172943,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryEvent" - } - } - }, - "description": "The JSON representation of the PostSecondaryEvent resource to be created or updated.", - "required": true, - "x-bodyName": "PostSecondaryEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -138898,7 +172960,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "postSecondaryEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPostSecondaryEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "postSecondaryEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPostSecondaryEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent" + } + } + }, + "description": "The JSON representation of the PostSecondaryEvent resource to be created or updated.", + "required": true, + "x-bodyName": "PostSecondaryEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139112,6 +173289,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -139228,7 +173466,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139271,7 +173509,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139291,27 +173529,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/postSecondaryInstitutionLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePostSecondaryInstitutionLevelsById", + "/ed-fi/postSecondaryInstitutionLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -139325,48 +173576,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "postSecondaryInstitutionLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postSecondaryInstitutionLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPostSecondaryInstitutionLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -139374,14 +173614,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -139393,20 +173633,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "postSecondaryInstitutionLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPostSecondaryInstitutionLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postSecondaryInstitutionLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePostSecondaryInstitutionLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -139421,18 +173665,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor" - } - } - }, - "description": "The JSON representation of the PostSecondaryInstitutionLevel resource to be created or updated.", - "required": true, - "x-bodyName": "PostSecondaryInstitutionLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -139450,7 +173682,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "postSecondaryInstitutionLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPostSecondaryInstitutionLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "postSecondaryInstitutionLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPostSecondaryInstitutionLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor" + } + } + }, + "description": "The JSON representation of the PostSecondaryInstitutionLevel resource to be created or updated.", + "required": true, + "x-bodyName": "PostSecondaryInstitutionLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -140811,6 +175158,62 @@ "postSecondaryInstitutionId" ], "type": "object" + }, + "EdFi_PostSecondaryInstitution_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitution_TrackedChangeKey": { + "properties": { + "postSecondaryInstitutionId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "postSecondaryInstitutionId" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitution_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -140936,7 +175339,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -140979,7 +175382,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141001,27 +175404,40 @@ "Graduation" ] }, - "/ed-fi/postSecondaryInstitutions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePostSecondaryInstitutionsById", + "/ed-fi/postSecondaryInstitutions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -141035,48 +175451,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "postSecondaryInstitutions" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Graduation" + ] + }, + "/ed-fi/postSecondaryInstitutions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPostSecondaryInstitutionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -141084,14 +175491,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution" + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -141103,20 +175510,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "postSecondaryInstitutions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPostSecondaryInstitution", + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Graduation" + ] + }, + "/ed-fi/postSecondaryInstitutions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePostSecondaryInstitutionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -141131,18 +175544,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution" - } - } - }, - "description": "The JSON representation of the PostSecondaryInstitution resource to be created or updated.", - "required": true, - "x-bodyName": "PostSecondaryInstitution" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -141160,7 +175561,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "postSecondaryInstitutions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPostSecondaryInstitutionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "postSecondaryInstitutions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPostSecondaryInstitution", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution" + } + } + }, + "description": "The JSON representation of the PostSecondaryInstitution resource to be created or updated.", + "required": true, + "x-bodyName": "PostSecondaryInstitution" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141407,6 +175923,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PostingResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostingResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PostingResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -141523,7 +176100,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141566,7 +176143,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141586,27 +176163,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/postingResultDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePostingResultsById", + "/ed-fi/postingResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostingResultsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -141620,48 +176210,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "postingResultDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postingResultDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPostingResultsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostingResultsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -141669,14 +176248,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PostingResultDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -141688,20 +176267,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "postingResultDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPostingResult", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/postingResultDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePostingResultsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -141716,18 +176299,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PostingResultDescriptor" - } - } - }, - "description": "The JSON representation of the PostingResult resource to be created or updated.", - "required": true, - "x-bodyName": "PostingResult" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -141745,7 +176316,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "postingResultDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPostingResultsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "postingResultDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPostingResult", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor" + } + } + }, + "description": "The JSON representation of the PostingResult resource to be created or updated.", + "required": true, + "x-bodyName": "PostingResult" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141970,6 +176656,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -142086,7 +176833,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142129,7 +176876,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142149,27 +176896,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/primaryLearningDeviceAccessDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePrimaryLearningDeviceAccessesById", + "/ed-fi/primaryLearningDeviceAccessDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAccessesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -142183,48 +176943,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "primaryLearningDeviceAccessDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceAccessDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPrimaryLearningDeviceAccessesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAccessesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -142232,14 +176981,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -142251,20 +177000,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "primaryLearningDeviceAccessDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPrimaryLearningDeviceAccess", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceAccessDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePrimaryLearningDeviceAccessesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -142279,18 +177032,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor" - } - } - }, - "description": "The JSON representation of the PrimaryLearningDeviceAccess resource to be created or updated.", - "required": true, - "x-bodyName": "PrimaryLearningDeviceAccess" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -142308,7 +177049,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "primaryLearningDeviceAccessDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPrimaryLearningDeviceAccessesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "primaryLearningDeviceAccessDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPrimaryLearningDeviceAccess", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor" + } + } + }, + "description": "The JSON representation of the PrimaryLearningDeviceAccess resource to be created or updated.", + "required": true, + "x-bodyName": "PrimaryLearningDeviceAccess" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142533,6 +177389,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -142649,7 +177566,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142692,7 +177609,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142712,27 +177629,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePrimaryLearningDeviceAwayFromSchoolsById", + "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAwayFromSchoolsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -142746,48 +177676,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "primaryLearningDeviceAwayFromSchoolDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPrimaryLearningDeviceAwayFromSchoolsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAwayFromSchoolsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -142795,14 +177714,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -142814,20 +177733,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "primaryLearningDeviceAwayFromSchoolDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPrimaryLearningDeviceAwayFromSchool", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePrimaryLearningDeviceAwayFromSchoolsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -142842,18 +177765,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor" - } - } - }, - "description": "The JSON representation of the PrimaryLearningDeviceAwayFromSchool resource to be created or updated.", - "required": true, - "x-bodyName": "PrimaryLearningDeviceAwayFromSchool" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -142871,7 +177782,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "primaryLearningDeviceAwayFromSchoolDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPrimaryLearningDeviceAwayFromSchoolsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "primaryLearningDeviceAwayFromSchoolDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPrimaryLearningDeviceAwayFromSchool", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor" + } + } + }, + "description": "The JSON representation of the PrimaryLearningDeviceAwayFromSchool resource to be created or updated.", + "required": true, + "x-bodyName": "PrimaryLearningDeviceAwayFromSchool" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -143096,6 +178122,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -143212,7 +178299,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143255,7 +178342,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -143275,27 +178362,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/primaryLearningDeviceProviderDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePrimaryLearningDeviceProvidersById", + "/ed-fi/primaryLearningDeviceProviderDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceProvidersDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -143309,48 +178409,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "primaryLearningDeviceProviderDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceProviderDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPrimaryLearningDeviceProvidersById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceProvidersKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -143358,14 +178447,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -143377,20 +178466,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "primaryLearningDeviceProviderDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPrimaryLearningDeviceProvider", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/primaryLearningDeviceProviderDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePrimaryLearningDeviceProvidersById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -143405,18 +178498,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor" - } - } - }, - "description": "The JSON representation of the PrimaryLearningDeviceProvider resource to be created or updated.", - "required": true, - "x-bodyName": "PrimaryLearningDeviceProvider" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -143434,7 +178515,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "primaryLearningDeviceProviderDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPrimaryLearningDeviceProvidersById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "primaryLearningDeviceProviderDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPrimaryLearningDeviceProvider", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor" + } + } + }, + "description": "The JSON representation of the PrimaryLearningDeviceProvider resource to be created or updated.", + "required": true, + "x-bodyName": "PrimaryLearningDeviceProvider" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -143659,6 +178855,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProficiencyDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProficiencyDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProficiencyDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -143775,7 +179032,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143818,7 +179075,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -143838,27 +179095,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/proficiencyDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProficienciesById", + "/ed-fi/proficiencyDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProficienciesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -143872,48 +179142,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "proficiencyDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/proficiencyDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProficienciesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProficienciesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -143921,14 +179180,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -143940,20 +179199,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "proficiencyDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProficiency", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/proficiencyDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProficienciesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -143968,18 +179231,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor" - } - } - }, - "description": "The JSON representation of the Proficiency resource to be created or updated.", - "required": true, - "x-bodyName": "Proficiency" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -143997,7 +179248,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "proficiencyDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProficienciesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "proficiencyDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProficiency", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor" + } + } + }, + "description": "The JSON representation of the Proficiency resource to be created or updated.", + "required": true, + "x-bodyName": "Proficiency" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144222,6 +179588,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramAssignmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramAssignmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramAssignmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -144338,7 +179765,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144381,7 +179808,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144401,27 +179828,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programAssignmentDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramAssignmentsById", + "/ed-fi/programAssignmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramAssignmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -144435,48 +179875,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programAssignmentDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programAssignmentDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramAssignmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramAssignmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -144484,14 +179913,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -144503,20 +179932,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programAssignmentDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramAssignment", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programAssignmentDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramAssignmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -144531,18 +179964,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramAssignment resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramAssignment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -144560,7 +179981,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programAssignmentDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramAssignmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programAssignmentDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramAssignment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramAssignment resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramAssignment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144785,6 +180321,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -144901,7 +180498,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144944,7 +180541,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144964,27 +180561,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programCharacteristicDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramCharacteristicsById", + "/ed-fi/programCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramCharacteristicsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -144998,48 +180608,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programCharacteristicDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programCharacteristicDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramCharacteristicsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramCharacteristicsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -145047,14 +180646,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -145066,20 +180665,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programCharacteristicDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramCharacteristic", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programCharacteristicDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramCharacteristicsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -145094,18 +180697,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramCharacteristic resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramCharacteristic" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -145123,7 +180714,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programCharacteristicDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramCharacteristicsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programCharacteristicDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramCharacteristic", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramCharacteristic resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramCharacteristic" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145410,6 +181116,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ProgramDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ProgramDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -145499,7 +181266,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145542,7 +181309,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145563,27 +181330,40 @@ "Finance" ] }, - "/ed-fi/programDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramDimensionsById", + "/ed-fi/programDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -145597,48 +181377,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/programDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -145646,14 +181416,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramDimension" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -145665,20 +181435,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/programDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -145693,18 +181468,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramDimension" - } - } - }, - "description": "The JSON representation of the ProgramDimension resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -145722,7 +181485,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramDimension" + } + } + }, + "description": "The JSON representation of the ProgramDimension resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146335,6 +182213,92 @@ "programEvaluationElementTitle" ], "type": "object" + }, + "EdFi_ProgramEvaluationElement_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationElement_TrackedChangeKey": { + "properties": { + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationElementTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "programEducationOrganizationId", + "programEvaluationElementTitle", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationElement_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -146511,7 +182475,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146554,7 +182518,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146575,27 +182539,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/programEvaluationElements/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramEvaluationElementsById", + "/ed-fi/programEvaluationElements/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationElementsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -146609,48 +182586,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programEvaluationElements" ] }, + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationElements/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramEvaluationElementsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationElementsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -146658,14 +182625,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -146677,20 +182644,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programEvaluationElements" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramEvaluationElement", + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationElements/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramEvaluationElementsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -146705,18 +182677,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement" - } - } - }, - "description": "The JSON representation of the ProgramEvaluationElement resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramEvaluationElement" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -146734,7 +182694,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programEvaluationElements" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramEvaluationElementsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programEvaluationElements" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramEvaluationElement", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement" + } + } + }, + "description": "The JSON representation of the ProgramEvaluationElement resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramEvaluationElement" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147285,6 +183360,92 @@ "programEvaluationObjectiveTitle" ], "type": "object" + }, + "EdFi_ProgramEvaluationObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationObjective_TrackedChangeKey": { + "properties": { + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationObjectiveTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "programEducationOrganizationId", + "programEvaluationObjectiveTitle", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -147451,7 +183612,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147494,7 +183655,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147515,27 +183676,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/programEvaluationObjectives/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramEvaluationObjectivesById", + "/ed-fi/programEvaluationObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationObjectivesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -147549,48 +183723,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programEvaluationObjectives" ] }, + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationObjectives/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramEvaluationObjectivesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationObjectivesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -147598,14 +183762,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -147617,20 +183781,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programEvaluationObjectives" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramEvaluationObjective", + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationObjectives/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramEvaluationObjectivesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -147645,18 +183814,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective" - } - } - }, - "description": "The JSON representation of the ProgramEvaluationObjective resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramEvaluationObjective" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -147674,7 +183831,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programEvaluationObjectives" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramEvaluationObjectivesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programEvaluationObjectives" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramEvaluationObjective", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective" + } + } + }, + "description": "The JSON representation of the ProgramEvaluationObjective resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramEvaluationObjective" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147940,6 +184212,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -148056,7 +184389,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148099,7 +184432,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148119,27 +184452,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programEvaluationPeriodDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramEvaluationPeriodsById", + "/ed-fi/programEvaluationPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationPeriodsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -148153,48 +184499,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programEvaluationPeriodDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programEvaluationPeriodDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramEvaluationPeriodsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationPeriodsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -148202,14 +184537,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -148221,20 +184556,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programEvaluationPeriodDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramEvaluationPeriod", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programEvaluationPeriodDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramEvaluationPeriodsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -148249,18 +184588,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramEvaluationPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramEvaluationPeriod" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -148278,7 +184605,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programEvaluationPeriodDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramEvaluationPeriodsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programEvaluationPeriodDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramEvaluationPeriod", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramEvaluationPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramEvaluationPeriod" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148503,6 +184945,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -148619,7 +185122,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148662,7 +185165,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148682,27 +185185,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programEvaluationTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramEvaluationTypesById", + "/ed-fi/programEvaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -148716,48 +185232,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programEvaluationTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programEvaluationTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramEvaluationTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -148765,14 +185270,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -148784,20 +185289,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programEvaluationTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramEvaluationType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programEvaluationTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramEvaluationTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -148812,18 +185321,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramEvaluationType resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramEvaluationType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -148841,7 +185338,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programEvaluationTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramEvaluationTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programEvaluationTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramEvaluationType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramEvaluationType resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramEvaluationType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149330,6 +185942,87 @@ "programEvaluationTypeDescriptor" ], "type": "object" + }, + "EdFi_ProgramEvaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluation_TrackedChangeKey": { + "properties": { + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "programEducationOrganizationId", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_ProgramEvaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -149477,7 +186170,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149520,7 +186213,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149541,27 +186234,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/programEvaluations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramEvaluationsById", + "/ed-fi/programEvaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -149575,48 +186281,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programEvaluations" ] }, + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramEvaluationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -149624,14 +186320,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluation" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -149643,20 +186339,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programEvaluations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramEvaluation", + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramEvaluationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -149671,18 +186372,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramEvaluation" - } - } - }, - "description": "The JSON representation of the ProgramEvaluation resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramEvaluation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -149700,7 +186389,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programEvaluations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramEvaluationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programEvaluations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramEvaluation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation" + } + } + }, + "description": "The JSON representation of the ProgramEvaluation resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramEvaluation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149953,6 +186757,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramSponsorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramSponsorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramSponsorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -150069,7 +186934,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150112,7 +186977,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150132,27 +186997,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programSponsorDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramSponsorsById", + "/ed-fi/programSponsorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramSponsorsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -150166,48 +187044,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programSponsorDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programSponsorDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramSponsorsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramSponsorsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -150215,14 +187082,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -150234,20 +187101,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programSponsorDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramSponsor", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programSponsorDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramSponsorsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -150262,18 +187133,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramSponsor resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramSponsor" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -150291,7 +187150,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programSponsorDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramSponsorsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programSponsorDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramSponsor", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramSponsor resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramSponsor" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150516,6 +187490,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -150632,7 +187667,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150675,7 +187710,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150695,27 +187730,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/programTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramTypesById", + "/ed-fi/programTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -150729,48 +187777,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -150778,14 +187815,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -150797,20 +187834,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgramType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/programTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -150825,18 +187866,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ProgramType resource to be created or updated.", - "required": true, - "x-bodyName": "ProgramType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -150854,7 +187883,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgramType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ProgramType resource to be created or updated.", + "required": true, + "x-bodyName": "ProgramType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151310,6 +188454,72 @@ "programTypeDescriptor" ], "type": "object" + }, + "EdFi_Program_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Program_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_Program_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -151409,7 +188619,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151452,7 +188662,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151484,27 +188694,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/programs/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgramsById", + "/ed-fi/programs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -151518,48 +188741,49 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "programs" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programs/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgramsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -151567,14 +188791,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Program" + "items": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -151586,20 +188810,36 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "programs" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgram", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programs/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgramsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -151614,18 +188854,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Program" - } - } - }, - "description": "The JSON representation of the Program resource to be created or updated.", - "required": true, - "x-bodyName": "Program" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -151643,7 +188871,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "programs" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgramsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Program" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "programs" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgram", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Program" + } + } + }, + "description": "The JSON representation of the Program resource to be created or updated.", + "required": true, + "x-bodyName": "Program" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151877,6 +189220,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgressDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgressDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgressDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -151993,7 +189397,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152036,7 +189440,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152056,27 +189460,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/progressDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgressesById", + "/ed-fi/progressDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgressesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -152090,48 +189507,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "progressDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/progressDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgressesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgressesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -152139,14 +189545,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgressDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -152158,20 +189564,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "progressDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgress", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/progressDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgressesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -152186,18 +189596,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgressDescriptor" - } - } - }, - "description": "The JSON representation of the Progress resource to be created or updated.", - "required": true, - "x-bodyName": "Progress" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -152215,7 +189613,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "progressDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgressesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "progressDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgress", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor" + } + } + }, + "description": "The JSON representation of the Progress resource to be created or updated.", + "required": true, + "x-bodyName": "Progress" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152440,6 +189953,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgressLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgressLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgressLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -152556,7 +190130,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152599,7 +190173,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152619,27 +190193,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/progressLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProgressLevelsById", + "/ed-fi/progressLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgressLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -152653,48 +190240,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "progressLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/progressLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProgressLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgressLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -152702,14 +190278,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -152721,20 +190297,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "progressLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProgressLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/progressLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProgressLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -152749,18 +190329,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor" - } - } - }, - "description": "The JSON representation of the ProgressLevel resource to be created or updated.", - "required": true, - "x-bodyName": "ProgressLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -152778,7 +190346,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "progressLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProgressLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "progressLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProgressLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor" + } + } + }, + "description": "The JSON representation of the ProgressLevel resource to be created or updated.", + "required": true, + "x-bodyName": "ProgressLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153065,6 +190748,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ProjectDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProjectDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ProjectDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -153154,7 +190898,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153197,7 +190941,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153218,27 +190962,40 @@ "Finance" ] }, - "/ed-fi/projectDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProjectDimensionsById", + "/ed-fi/projectDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProjectDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -153252,48 +191009,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "projectDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/projectDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProjectDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProjectDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -153301,14 +191048,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProjectDimension" + "items": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -153320,20 +191067,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "projectDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProjectDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/projectDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProjectDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -153348,18 +191100,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProjectDimension" - } - } - }, - "description": "The JSON representation of the ProjectDimension resource to be created or updated.", - "required": true, - "x-bodyName": "ProjectDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -153377,7 +191117,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "projectDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProjectDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProjectDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "projectDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProjectDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProjectDimension" + } + } + }, + "description": "The JSON representation of the ProjectDimension resource to be created or updated.", + "required": true, + "x-bodyName": "ProjectDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153584,6 +191439,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProviderCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProviderCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProviderCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -153700,7 +191616,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153743,7 +191659,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153763,27 +191679,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/providerCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProviderCategoriesById", + "/ed-fi/providerCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProviderCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -153797,48 +191726,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "providerCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProviderCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProviderCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -153846,14 +191764,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -153865,20 +191783,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "providerCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProviderCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProviderCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -153893,18 +191815,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the ProviderCategory resource to be created or updated.", - "required": true, - "x-bodyName": "ProviderCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -153922,7 +191832,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "providerCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProviderCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "providerCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProviderCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the ProviderCategory resource to be created or updated.", + "required": true, + "x-bodyName": "ProviderCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154147,6 +192172,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProviderProfitabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProviderProfitabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -154263,7 +192349,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154306,7 +192392,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154326,27 +192412,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/providerProfitabilityDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProviderProfitabilitiesById", + "/ed-fi/providerProfitabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProviderProfitabilitiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -154360,48 +192459,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "providerProfitabilityDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerProfitabilityDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProviderProfitabilitiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProviderProfitabilitiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -154409,14 +192497,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -154428,20 +192516,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "providerProfitabilityDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProviderProfitability", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerProfitabilityDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProviderProfitabilitiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -154456,18 +192548,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor" - } - } - }, - "description": "The JSON representation of the ProviderProfitability resource to be created or updated.", - "required": true, - "x-bodyName": "ProviderProfitability" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -154485,7 +192565,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "providerProfitabilityDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProviderProfitabilitiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "providerProfitabilityDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProviderProfitability", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor" + } + } + }, + "description": "The JSON representation of the ProviderProfitability resource to be created or updated.", + "required": true, + "x-bodyName": "ProviderProfitability" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154710,6 +192905,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProviderStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProviderStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProviderStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -154826,7 +193082,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154869,7 +193125,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154889,27 +193145,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/providerStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteProviderStatusesById", + "/ed-fi/providerStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProviderStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -154923,48 +193192,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "providerStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getProviderStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProviderStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -154972,14 +193230,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -154991,20 +193249,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "providerStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putProviderStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/providerStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteProviderStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -155019,18 +193281,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor" - } - } - }, - "description": "The JSON representation of the ProviderStatus resource to be created or updated.", - "required": true, - "x-bodyName": "ProviderStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -155048,7 +193298,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "providerStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getProviderStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "providerStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putProviderStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor" + } + } + }, + "description": "The JSON representation of the ProviderStatus resource to be created or updated.", + "required": true, + "x-bodyName": "ProviderStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -155273,6 +193638,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PublicationStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PublicationStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PublicationStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -155389,7 +193815,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155432,7 +193858,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -155452,27 +193878,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/publicationStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deletePublicationStatusesById", + "/ed-fi/publicationStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPublicationStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -155486,48 +193925,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "publicationStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/publicationStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getPublicationStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPublicationStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -155535,14 +193963,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -155554,20 +193982,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "publicationStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putPublicationStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/publicationStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deletePublicationStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -155582,18 +194014,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor" - } - } - }, - "description": "The JSON representation of the PublicationStatus resource to be created or updated.", - "required": true, - "x-bodyName": "PublicationStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -155611,7 +194031,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "publicationStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getPublicationStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "publicationStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putPublicationStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor" + } + } + }, + "description": "The JSON representation of the PublicationStatus resource to be created or updated.", + "required": true, + "x-bodyName": "PublicationStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -155836,6 +194371,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_QuestionFormDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_QuestionFormDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_QuestionFormDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -155952,7 +194548,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155995,7 +194591,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156015,27 +194611,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/questionFormDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteQuestionFormsById", + "/ed-fi/questionFormDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getQuestionFormsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -156049,48 +194658,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "questionFormDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/questionFormDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getQuestionFormsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getQuestionFormsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -156098,14 +194696,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -156117,20 +194715,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "questionFormDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putQuestionForm", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/questionFormDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteQuestionFormsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -156145,18 +194747,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor" - } - } - }, - "description": "The JSON representation of the QuestionForm resource to be created or updated.", - "required": true, - "x-bodyName": "QuestionForm" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -156174,7 +194764,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "questionFormDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getQuestionFormsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "questionFormDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putQuestionForm", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor" + } + } + }, + "description": "The JSON representation of the QuestionForm resource to be created or updated.", + "required": true, + "x-bodyName": "QuestionForm" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156399,6 +195104,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RaceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RaceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RaceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -156515,7 +195281,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156558,7 +195324,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156578,27 +195344,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/raceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRacesById", + "/ed-fi/raceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRacesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -156612,48 +195391,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "raceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/raceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRacesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRacesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -156661,14 +195429,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RaceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -156680,20 +195448,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "raceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRace", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/raceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRacesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -156708,18 +195480,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RaceDescriptor" - } - } - }, - "description": "The JSON representation of the Race resource to be created or updated.", - "required": true, - "x-bodyName": "Race" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -156737,7 +195497,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "raceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRacesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "raceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRace", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor" + } + } + }, + "description": "The JSON representation of the Race resource to be created or updated.", + "required": true, + "x-bodyName": "Race" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156962,6 +195837,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -157078,7 +196014,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157121,7 +196057,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157141,27 +196077,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/ratingLevelDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRatingLevelsById", + "/ed-fi/ratingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRatingLevelsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -157175,48 +196124,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "ratingLevelDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ratingLevelDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRatingLevelsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRatingLevelsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -157224,14 +196162,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -157243,20 +196181,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "ratingLevelDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRatingLevel", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/ratingLevelDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRatingLevelsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -157271,18 +196213,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor" - } - } - }, - "description": "The JSON representation of the RatingLevel resource to be created or updated.", - "required": true, - "x-bodyName": "RatingLevel" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -157300,7 +196230,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "ratingLevelDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRatingLevelsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "ratingLevelDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRatingLevel", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor" + } + } + }, + "description": "The JSON representation of the RatingLevel resource to be created or updated.", + "required": true, + "x-bodyName": "RatingLevel" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157525,6 +196570,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReasonExitedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReasonExitedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReasonExitedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -157641,7 +196747,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157684,7 +196790,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157704,27 +196810,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/reasonExitedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteReasonExitedsById", + "/ed-fi/reasonExitedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReasonExitedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -157738,48 +196857,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "reasonExitedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reasonExitedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getReasonExitedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReasonExitedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -157787,14 +196895,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -157806,20 +196914,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "reasonExitedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putReasonExited", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reasonExitedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteReasonExitedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -157834,18 +196946,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor" - } - } - }, - "description": "The JSON representation of the ReasonExited resource to be created or updated.", - "required": true, - "x-bodyName": "ReasonExited" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -157863,7 +196963,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "reasonExitedDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getReasonExitedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "reasonExitedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putReasonExited", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor" + } + } + }, + "description": "The JSON representation of the ReasonExited resource to be created or updated.", + "required": true, + "x-bodyName": "ReasonExited" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158088,6 +197303,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReasonNotTestedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReasonNotTestedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReasonNotTestedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -158204,7 +197480,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158247,7 +197523,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158267,27 +197543,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/reasonNotTestedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteReasonNotTestedsById", + "/ed-fi/reasonNotTestedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReasonNotTestedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -158301,48 +197590,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "reasonNotTestedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reasonNotTestedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getReasonNotTestedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReasonNotTestedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -158350,14 +197628,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -158369,20 +197647,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "reasonNotTestedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putReasonNotTested", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reasonNotTestedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteReasonNotTestedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -158397,18 +197679,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor" - } - } - }, - "description": "The JSON representation of the ReasonNotTested resource to be created or updated.", - "required": true, - "x-bodyName": "ReasonNotTested" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -158426,7 +197696,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "reasonNotTestedDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getReasonNotTestedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "reasonNotTestedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putReasonNotTested", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor" + } + } + }, + "description": "The JSON representation of the ReasonNotTested resource to be created or updated.", + "required": true, + "x-bodyName": "ReasonNotTested" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158651,6 +198036,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RecognitionTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RecognitionTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RecognitionTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -158767,7 +198213,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158810,7 +198256,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158830,27 +198276,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/recognitionTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRecognitionTypesById", + "/ed-fi/recognitionTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRecognitionTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -158864,48 +198323,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "recognitionTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/recognitionTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRecognitionTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRecognitionTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -158913,14 +198361,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -158932,20 +198380,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "recognitionTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRecognitionType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/recognitionTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRecognitionTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -158960,18 +198412,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor" - } - } - }, - "description": "The JSON representation of the RecognitionType resource to be created or updated.", - "required": true, - "x-bodyName": "RecognitionType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -158989,7 +198429,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "recognitionTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRecognitionTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "recognitionTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRecognitionType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor" + } + } + }, + "description": "The JSON representation of the RecognitionType resource to be created or updated.", + "required": true, + "x-bodyName": "RecognitionType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159214,6 +198769,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RelationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RelationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RelationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -159330,7 +198946,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159373,7 +198989,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159393,27 +199009,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/relationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRelationsById", + "/ed-fi/relationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRelationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -159427,48 +199056,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "relationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/relationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRelationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRelationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -159476,14 +199094,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RelationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -159495,20 +199113,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "relationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRelation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/relationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRelationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -159523,18 +199145,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RelationDescriptor" - } - } - }, - "description": "The JSON representation of the Relation resource to be created or updated.", - "required": true, - "x-bodyName": "Relation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -159552,7 +199162,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "relationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRelationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "relationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRelation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor" + } + } + }, + "description": "The JSON representation of the Relation resource to be created or updated.", + "required": true, + "x-bodyName": "Relation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159777,6 +199502,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RepeatIdentifierDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RepeatIdentifierDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RepeatIdentifierDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -159893,7 +199679,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159936,7 +199722,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159956,27 +199742,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/repeatIdentifierDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRepeatIdentifiersById", + "/ed-fi/repeatIdentifierDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRepeatIdentifiersDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -159990,48 +199789,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "repeatIdentifierDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/repeatIdentifierDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRepeatIdentifiersById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRepeatIdentifiersKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -160039,14 +199827,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -160058,20 +199846,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "repeatIdentifierDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRepeatIdentifier", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/repeatIdentifierDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRepeatIdentifiersById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -160086,18 +199878,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor" - } - } - }, - "description": "The JSON representation of the RepeatIdentifier resource to be created or updated.", - "required": true, - "x-bodyName": "RepeatIdentifier" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -160115,7 +199895,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "repeatIdentifierDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRepeatIdentifiersById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "repeatIdentifierDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRepeatIdentifier", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor" + } + } + }, + "description": "The JSON representation of the RepeatIdentifier resource to be created or updated.", + "required": true, + "x-bodyName": "RepeatIdentifier" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -161020,6 +200915,87 @@ "studentCompetencyObjectiveReference" ], "type": "object" + }, + "EdFi_ReportCard_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReportCard_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "type": "string" + }, + "gradingPeriodSchoolId": { + "format": "int64", + "type": "integer" + }, + "gradingPeriodSchoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolId", + "gradingPeriodSchoolYear", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_ReportCard_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -161167,7 +201143,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -161210,7 +201186,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -161232,27 +201208,40 @@ "ReportCard" ] }, - "/ed-fi/reportCards/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteReportCardsById", + "/ed-fi/reportCards/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReportCardsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -161266,48 +201255,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "reportCards" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/reportCards/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getReportCardsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReportCardsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -161315,14 +201295,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ReportCard" + "items": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -161334,20 +201314,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "reportCards" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putReportCard", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/reportCards/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteReportCardsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -161362,18 +201348,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ReportCard" - } - } - }, - "description": "The JSON representation of the ReportCard resource to be created or updated.", - "required": true, - "x-bodyName": "ReportCard" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -161391,7 +201365,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "reportCards" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getReportCardsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReportCard" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "reportCards" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putReportCard", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReportCard" + } + } + }, + "description": "The JSON representation of the ReportCard resource to be created or updated.", + "required": true, + "x-bodyName": "ReportCard" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -161645,6 +201734,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReporterDescriptionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReporterDescriptionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReporterDescriptionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -161761,7 +201911,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -161804,7 +201954,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -161824,27 +201974,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/reporterDescriptionDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteReporterDescriptionsById", + "/ed-fi/reporterDescriptionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReporterDescriptionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -161858,48 +202021,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "reporterDescriptionDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reporterDescriptionDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getReporterDescriptionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReporterDescriptionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -161907,14 +202059,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -161926,20 +202078,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "reporterDescriptionDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putReporterDescription", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reporterDescriptionDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteReporterDescriptionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -161954,18 +202110,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor" - } - } - }, - "description": "The JSON representation of the ReporterDescription resource to be created or updated.", - "required": true, - "x-bodyName": "ReporterDescription" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -161983,7 +202127,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "reporterDescriptionDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getReporterDescriptionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "reporterDescriptionDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putReporterDescription", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor" + } + } + }, + "description": "The JSON representation of the ReporterDescription resource to be created or updated.", + "required": true, + "x-bodyName": "ReporterDescription" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162208,6 +202467,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReportingTagDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReportingTagDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReportingTagDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -162324,7 +202644,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162367,7 +202687,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162387,27 +202707,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/reportingTagDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteReportingTagsById", + "/ed-fi/reportingTagDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReportingTagsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -162421,48 +202754,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "reportingTagDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reportingTagDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getReportingTagsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReportingTagsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -162470,14 +202792,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -162489,20 +202811,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "reportingTagDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putReportingTag", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/reportingTagDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteReportingTagsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -162517,18 +202843,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor" - } - } - }, - "description": "The JSON representation of the ReportingTag resource to be created or updated.", - "required": true, - "x-bodyName": "ReportingTag" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -162546,7 +202860,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "reportingTagDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getReportingTagsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "reportingTagDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putReportingTag", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor" + } + } + }, + "description": "The JSON representation of the ReportingTag resource to be created or updated.", + "required": true, + "x-bodyName": "ReportingTag" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162771,6 +203200,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResidencyStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResidencyStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResidencyStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -162887,7 +203377,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162930,7 +203420,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162950,27 +203440,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/residencyStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteResidencyStatusesById", + "/ed-fi/residencyStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResidencyStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -162984,48 +203487,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "residencyStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/residencyStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getResidencyStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResidencyStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -163033,14 +203525,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -163052,20 +203544,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "residencyStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putResidencyStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/residencyStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteResidencyStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -163080,18 +203576,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor" - } - } - }, - "description": "The JSON representation of the ResidencyStatus resource to be created or updated.", - "required": true, - "x-bodyName": "ResidencyStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -163109,7 +203593,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "residencyStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getResidencyStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "residencyStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putResidencyStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor" + } + } + }, + "description": "The JSON representation of the ResidencyStatus resource to be created or updated.", + "required": true, + "x-bodyName": "ResidencyStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163334,6 +203933,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResponseIndicatorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResponseIndicatorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResponseIndicatorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -163450,7 +204110,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163493,7 +204153,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163513,27 +204173,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/responseIndicatorDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteResponseIndicatorsById", + "/ed-fi/responseIndicatorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResponseIndicatorsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -163547,48 +204220,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "responseIndicatorDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/responseIndicatorDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getResponseIndicatorsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResponseIndicatorsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -163596,14 +204258,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -163615,20 +204277,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "responseIndicatorDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putResponseIndicator", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/responseIndicatorDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteResponseIndicatorsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -163643,18 +204309,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor" - } - } - }, - "description": "The JSON representation of the ResponseIndicator resource to be created or updated.", - "required": true, - "x-bodyName": "ResponseIndicator" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -163672,7 +204326,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "responseIndicatorDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getResponseIndicatorsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "responseIndicatorDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putResponseIndicator", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor" + } + } + }, + "description": "The JSON representation of the ResponseIndicator resource to be created or updated.", + "required": true, + "x-bodyName": "ResponseIndicator" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163897,6 +204666,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResponsibilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResponsibilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResponsibilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -164013,7 +204843,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164056,7 +204886,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164076,27 +204906,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/responsibilityDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteResponsibilitiesById", + "/ed-fi/responsibilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResponsibilitiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -164110,48 +204953,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "responsibilityDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/responsibilityDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getResponsibilitiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResponsibilitiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -164159,14 +204991,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -164178,20 +205010,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "responsibilityDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putResponsibility", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/responsibilityDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteResponsibilitiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -164206,18 +205042,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor" - } - } - }, - "description": "The JSON representation of the Responsibility resource to be created or updated.", - "required": true, - "x-bodyName": "Responsibility" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -164235,7 +205059,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "responsibilityDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getResponsibilitiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "responsibilityDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putResponsibility", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor" + } + } + }, + "description": "The JSON representation of the Responsibility resource to be created or updated.", + "required": true, + "x-bodyName": "Responsibility" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164460,6 +205399,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RestraintEventReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RestraintEventReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RestraintEventReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -164576,7 +205576,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164619,7 +205619,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164639,27 +205639,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/restraintEventReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRestraintEventReasonsById", + "/ed-fi/restraintEventReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -164673,48 +205686,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "restraintEventReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/restraintEventReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRestraintEventReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -164722,14 +205724,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -164741,20 +205743,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "restraintEventReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRestraintEventReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/restraintEventReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRestraintEventReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -164769,18 +205775,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor" - } - } - }, - "description": "The JSON representation of the RestraintEventReason resource to be created or updated.", - "required": true, - "x-bodyName": "RestraintEventReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -164798,7 +205792,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "restraintEventReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRestraintEventReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "restraintEventReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRestraintEventReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor" + } + } + }, + "description": "The JSON representation of the RestraintEventReason resource to be created or updated.", + "required": true, + "x-bodyName": "RestraintEventReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165297,6 +206406,72 @@ "restraintEventReasonDescriptor" ], "type": "object" + }, + "EdFi_RestraintEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RestraintEvent_TrackedChangeKey": { + "properties": { + "restraintEventIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "restraintEventIdentifier", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_RestraintEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -165415,7 +206590,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165458,7 +206633,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165479,27 +206654,40 @@ "SpecialEducation" ] }, - "/ed-fi/restraintEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRestraintEventsById", + "/ed-fi/restraintEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -165513,48 +206701,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "restraintEvents" ] }, + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, + "/ed-fi/restraintEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRestraintEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -165562,14 +206740,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RestraintEvent" + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -165581,20 +206759,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "restraintEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRestraintEvent", + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, + "/ed-fi/restraintEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRestraintEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -165609,18 +206792,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RestraintEvent" - } - } - }, - "description": "The JSON representation of the RestraintEvent resource to be created or updated.", - "required": true, - "x-bodyName": "RestraintEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -165638,7 +206809,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "restraintEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRestraintEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RestraintEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "restraintEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRestraintEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RestraintEvent" + } + } + }, + "description": "The JSON representation of the RestraintEvent resource to be created or updated.", + "required": true, + "x-bodyName": "RestraintEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165873,6 +207159,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResultDatatypeTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -165989,7 +207336,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166032,7 +207379,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166052,27 +207399,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/resultDatatypeTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteResultDatatypeTypesById", + "/ed-fi/resultDatatypeTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResultDatatypeTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -166086,48 +207446,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "resultDatatypeTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/resultDatatypeTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getResultDatatypeTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResultDatatypeTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -166135,14 +207484,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -166154,20 +207503,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "resultDatatypeTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putResultDatatypeType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/resultDatatypeTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteResultDatatypeTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -166182,18 +207535,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor" - } - } - }, - "description": "The JSON representation of the ResultDatatypeType resource to be created or updated.", - "required": true, - "x-bodyName": "ResultDatatypeType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -166211,7 +207552,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "resultDatatypeTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getResultDatatypeTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "resultDatatypeTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putResultDatatypeType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor" + } + } + }, + "description": "The JSON representation of the ResultDatatypeType resource to be created or updated.", + "required": true, + "x-bodyName": "ResultDatatypeType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166436,6 +207892,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RetestIndicatorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RetestIndicatorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RetestIndicatorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -166552,7 +208069,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166595,7 +208112,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166615,27 +208132,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/retestIndicatorDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteRetestIndicatorsById", + "/ed-fi/retestIndicatorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRetestIndicatorsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -166649,48 +208179,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "retestIndicatorDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/retestIndicatorDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getRetestIndicatorsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRetestIndicatorsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -166698,14 +208217,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -166717,20 +208236,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "retestIndicatorDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putRetestIndicator", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/retestIndicatorDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteRetestIndicatorsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -166745,18 +208268,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor" - } - } - }, - "description": "The JSON representation of the RetestIndicator resource to be created or updated.", - "required": true, - "x-bodyName": "RetestIndicator" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -166774,7 +208285,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "retestIndicatorDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getRetestIndicatorsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "retestIndicatorDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putRetestIndicator", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor" + } + } + }, + "description": "The JSON representation of the RetestIndicator resource to be created or updated.", + "required": true, + "x-bodyName": "RetestIndicator" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166999,6 +208625,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -167115,7 +208802,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -167158,7 +208845,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -167178,27 +208865,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/schoolCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSchoolCategoriesById", + "/ed-fi/schoolCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -167212,48 +208912,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "schoolCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSchoolCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -167261,14 +208950,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -167280,20 +208969,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "schoolCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSchoolCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSchoolCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -167308,18 +209001,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the SchoolCategory resource to be created or updated.", - "required": true, - "x-bodyName": "SchoolCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -167337,7 +209018,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "schoolCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSchoolCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "schoolCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSchoolCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the SchoolCategory resource to be created or updated.", + "required": true, + "x-bodyName": "SchoolCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -167562,6 +209358,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolChoiceBasisDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -167678,7 +209535,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -167721,7 +209578,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -167741,27 +209598,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/schoolChoiceBasisDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSchoolChoiceBasesById", + "/ed-fi/schoolChoiceBasisDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceBasesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -167775,48 +209645,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "schoolChoiceBasisDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolChoiceBasisDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSchoolChoiceBasesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceBasesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -167824,14 +209683,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -167843,20 +209702,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "schoolChoiceBasisDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSchoolChoiceBasis", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolChoiceBasisDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSchoolChoiceBasesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -167871,18 +209734,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor" - } - } - }, - "description": "The JSON representation of the SchoolChoiceBasis resource to be created or updated.", - "required": true, - "x-bodyName": "SchoolChoiceBasis" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -167900,7 +209751,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "schoolChoiceBasisDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSchoolChoiceBasesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "schoolChoiceBasisDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSchoolChoiceBasis", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor" + } + } + }, + "description": "The JSON representation of the SchoolChoiceBasis resource to be created or updated.", + "required": true, + "x-bodyName": "SchoolChoiceBasis" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -168125,6 +210091,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -168241,7 +210268,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -168284,7 +210311,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -168304,27 +210331,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/schoolChoiceImplementStatusDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSchoolChoiceImplementStatusesById", + "/ed-fi/schoolChoiceImplementStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceImplementStatusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -168338,48 +210378,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "schoolChoiceImplementStatusDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolChoiceImplementStatusDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSchoolChoiceImplementStatusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceImplementStatusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -168387,14 +210416,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -168406,20 +210435,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "schoolChoiceImplementStatusDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSchoolChoiceImplementStatus", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolChoiceImplementStatusDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSchoolChoiceImplementStatusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -168434,18 +210467,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor" - } - } - }, - "description": "The JSON representation of the SchoolChoiceImplementStatus resource to be created or updated.", - "required": true, - "x-bodyName": "SchoolChoiceImplementStatus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -168463,7 +210484,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "schoolChoiceImplementStatusDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSchoolChoiceImplementStatusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "schoolChoiceImplementStatusDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSchoolChoiceImplementStatus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor" + } + } + }, + "description": "The JSON representation of the SchoolChoiceImplementStatus resource to be created or updated.", + "required": true, + "x-bodyName": "SchoolChoiceImplementStatus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -168688,6 +210824,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -168804,7 +211001,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -168847,7 +211044,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -168867,27 +211064,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/schoolFoodServiceProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSchoolFoodServiceProgramServicesById", + "/ed-fi/schoolFoodServiceProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolFoodServiceProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -168901,48 +211111,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "schoolFoodServiceProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolFoodServiceProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSchoolFoodServiceProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolFoodServiceProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -168950,14 +211149,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -168969,20 +211168,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "schoolFoodServiceProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSchoolFoodServiceProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolFoodServiceProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSchoolFoodServiceProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -168997,18 +211200,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the SchoolFoodServiceProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "SchoolFoodServiceProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -169026,7 +211217,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "schoolFoodServiceProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSchoolFoodServiceProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "schoolFoodServiceProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSchoolFoodServiceProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the SchoolFoodServiceProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "SchoolFoodServiceProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169251,6 +211557,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -169367,7 +211734,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169410,7 +211777,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169430,27 +211797,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/schoolTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSchoolTypesById", + "/ed-fi/schoolTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -169464,48 +211844,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "schoolTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSchoolTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -169513,14 +211882,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -169532,20 +211901,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "schoolTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSchoolType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSchoolTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -169560,18 +211933,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor" - } - } - }, - "description": "The JSON representation of the SchoolType resource to be created or updated.", - "required": true, - "x-bodyName": "SchoolType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -169589,7 +211950,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "schoolTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSchoolTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "schoolTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSchoolType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor" + } + } + }, + "description": "The JSON representation of the SchoolType resource to be created or updated.", + "required": true, + "x-bodyName": "SchoolType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169783,6 +212259,62 @@ "schoolYear" ], "type": "object" + }, + "EdFi_SchoolYear_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolYear_TrackedChangeKey": { + "properties": { + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "schoolYear" + ], + "type": "object" + }, + "EdFi_SchoolYear_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -169868,7 +212400,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169911,7 +212443,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169931,6 +212463,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/schoolYearTypes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolYearsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolYearTypes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolYearTypes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolYearsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolYearTypes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/schoolYearTypes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -169966,7 +212616,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169998,15 +212648,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -170033,7 +212674,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170090,7 +212731,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -171675,6 +214316,62 @@ "schoolCategoryDescriptor" ], "type": "object" + }, + "EdFi_School_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_School_TrackedChangeKey": { + "properties": { + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "schoolId" + ], + "type": "object" + }, + "EdFi_School_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -171864,7 +214561,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -171907,7 +214604,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -171941,6 +214638,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/schools/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schools" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/schools/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schools" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/schools/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -171976,7 +214819,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172008,15 +214851,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -172043,7 +214877,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172100,7 +214934,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172403,6 +215237,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_Section504DisabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Section504DisabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_Section504DisabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -172519,7 +215414,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172562,7 +215457,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172582,27 +215477,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/section504DisabilityDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSection504DisabilitiesById", + "/ed-fi/section504DisabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSection504DisabilitiesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -172616,48 +215524,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "section504DisabilityDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/section504DisabilityDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSection504DisabilitiesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSection504DisabilitiesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -172665,14 +215562,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -172684,20 +215581,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "section504DisabilityDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSection504Disability", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/section504DisabilityDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSection504DisabilitiesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -172712,18 +215613,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor" - } - } - }, - "description": "The JSON representation of the Section504Disability resource to be created or updated.", - "required": true, - "x-bodyName": "Section504Disability" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -172741,7 +215630,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "section504DisabilityDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSection504DisabilitiesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "section504DisabilityDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSection504Disability", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor" + } + } + }, + "description": "The JSON representation of the Section504Disability resource to be created or updated.", + "required": true, + "x-bodyName": "Section504Disability" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173171,6 +216175,92 @@ "sectionIdentifier" ], "type": "object" + }, + "EdFi_SectionAttendanceTakenEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SectionAttendanceTakenEvent_TrackedChangeKey": { + "properties": { + "calendarCode": { + "maxLength": 60, + "type": "string" + }, + "date": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "calendarCode", + "date", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName" + ], + "type": "object" + }, + "EdFi_SectionAttendanceTakenEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -173320,7 +216410,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173363,7 +216453,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173384,27 +216474,40 @@ "StudentAttendance" ] }, - "/ed-fi/sectionAttendanceTakenEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSectionAttendanceTakenEventsById", + "/ed-fi/sectionAttendanceTakenEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionAttendanceTakenEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -173418,48 +216521,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sectionAttendanceTakenEvents" ] }, + "x-Ed-Fi-domains": [ + "StudentAttendance" + ] + }, + "/ed-fi/sectionAttendanceTakenEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSectionAttendanceTakenEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionAttendanceTakenEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -173467,14 +216560,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent" + "items": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -173486,20 +216579,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sectionAttendanceTakenEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSectionAttendanceTakenEvent", + "x-Ed-Fi-domains": [ + "StudentAttendance" + ] + }, + "/ed-fi/sectionAttendanceTakenEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSectionAttendanceTakenEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -173514,18 +216612,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent" - } - } - }, - "description": "The JSON representation of the SectionAttendanceTakenEvent resource to be created or updated.", - "required": true, - "x-bodyName": "SectionAttendanceTakenEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -173543,7 +216629,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sectionAttendanceTakenEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSectionAttendanceTakenEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sectionAttendanceTakenEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSectionAttendanceTakenEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent" + } + } + }, + "description": "The JSON representation of the SectionAttendanceTakenEvent resource to be created or updated.", + "required": true, + "x-bodyName": "SectionAttendanceTakenEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173794,6 +216995,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SectionCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SectionCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SectionCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -173910,7 +217172,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173953,7 +217215,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173973,27 +217235,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/sectionCharacteristicDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSectionCharacteristicsById", + "/ed-fi/sectionCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionCharacteristicsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -174007,48 +217282,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sectionCharacteristicDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sectionCharacteristicDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSectionCharacteristicsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionCharacteristicsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -174056,14 +217320,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -174075,20 +217339,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sectionCharacteristicDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSectionCharacteristic", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sectionCharacteristicDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSectionCharacteristicsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -174103,18 +217371,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor" - } - } - }, - "description": "The JSON representation of the SectionCharacteristic resource to be created or updated.", - "required": true, - "x-bodyName": "SectionCharacteristic" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -174132,7 +217388,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sectionCharacteristicDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSectionCharacteristicsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sectionCharacteristicDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSectionCharacteristic", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor" + } + } + }, + "description": "The JSON representation of the SectionCharacteristic resource to be created or updated.", + "required": true, + "x-bodyName": "SectionCharacteristic" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -174357,6 +217728,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SectionTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SectionTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SectionTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -174473,7 +217905,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -174516,7 +217948,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -174536,27 +217968,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/sectionTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSectionTypesById", + "/ed-fi/sectionTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -174570,48 +218015,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sectionTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sectionTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSectionTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -174619,14 +218053,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -174638,20 +218072,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sectionTypeDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSectionType", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sectionTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSectionTypesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -174666,18 +218104,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor" - } - } - }, - "description": "The JSON representation of the SectionType resource to be created or updated.", - "required": true, - "x-bodyName": "SectionType" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -174695,7 +218121,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sectionTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSectionTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sectionTypeDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSectionType", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor" + } + } + }, + "description": "The JSON representation of the SectionType resource to be created or updated.", + "required": true, + "x-bodyName": "SectionType" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -175641,6 +219182,82 @@ "sectionCharacteristicDescriptor" ], "type": "object" + }, + "EdFi_Section_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Section_TrackedChangeKey": { + "properties": { + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName" + ], + "type": "object" + }, + "EdFi_Section_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -175869,7 +219486,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175912,7 +219529,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -175945,27 +219562,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/sections/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSectionsById", + "/ed-fi/sections/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -175979,48 +219609,50 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sections" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sections/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSectionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -176028,14 +219660,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Section" + "items": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -176047,20 +219679,37 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sections" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSection", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sections/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSectionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -176075,18 +219724,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Section" - } - } - }, - "description": "The JSON representation of the Section resource to be created or updated.", - "required": true, - "x-bodyName": "Section" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -176104,7 +219741,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sections" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSectionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Section" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sections" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSection", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Section" + } + } + }, + "description": "The JSON representation of the Section resource to be created or updated.", + "required": true, + "x-bodyName": "Section" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176425,6 +220177,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SeparationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SeparationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SeparationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -176541,7 +220354,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176584,7 +220397,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176604,27 +220417,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/separationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSeparationsById", + "/ed-fi/separationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -176638,48 +220464,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "separationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/separationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSeparationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -176687,14 +220502,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SeparationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -176706,20 +220521,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "separationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSeparation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/separationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSeparationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -176734,18 +220553,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SeparationDescriptor" - } - } - }, - "description": "The JSON representation of the Separation resource to be created or updated.", - "required": true, - "x-bodyName": "Separation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -176763,7 +220570,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "separationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSeparationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "separationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSeparation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor" + } + } + }, + "description": "The JSON representation of the Separation resource to be created or updated.", + "required": true, + "x-bodyName": "Separation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176988,6 +220910,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SeparationReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SeparationReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SeparationReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -177104,7 +221087,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177147,7 +221130,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177167,27 +221150,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/separationReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSeparationReasonsById", + "/ed-fi/separationReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -177201,48 +221197,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "separationReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/separationReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSeparationReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -177250,14 +221235,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -177269,20 +221254,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "separationReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSeparationReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/separationReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSeparationReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -177297,18 +221286,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor" - } - } - }, - "description": "The JSON representation of the SeparationReason resource to be created or updated.", - "required": true, - "x-bodyName": "SeparationReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -177326,7 +221303,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "separationReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSeparationReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "separationReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSeparationReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor" + } + } + }, + "description": "The JSON representation of the SeparationReason resource to be created or updated.", + "required": true, + "x-bodyName": "SeparationReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177551,6 +221643,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -177667,7 +221820,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177710,7 +221863,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177730,27 +221883,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/serviceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteServicesById", + "/ed-fi/serviceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -177764,48 +221930,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "serviceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/serviceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -177813,14 +221968,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_ServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -177832,20 +221987,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "serviceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/serviceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -177860,18 +222019,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_ServiceDescriptor" - } - } - }, - "description": "The JSON representation of the Service resource to be created or updated.", - "required": true, - "x-bodyName": "Service" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -177889,7 +222036,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "serviceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "serviceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor" + } + } + }, + "description": "The JSON representation of the Service resource to be created or updated.", + "required": true, + "x-bodyName": "Service" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178437,6 +222699,72 @@ "sessionName" ], "type": "object" + }, + "EdFi_Session_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Session_TrackedChangeKey": { + "properties": { + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ], + "type": "object" + }, + "EdFi_Session_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -178563,7 +222891,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178606,7 +222934,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178634,27 +222962,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/sessions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSessionsById", + "/ed-fi/sessions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSessionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -178668,48 +223009,45 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sessions" ] }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "SchoolCalendar", + "StudentAcademicRecord", + "StudentAttendance", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sessions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSessionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSessionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -178717,14 +223055,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Session" + "items": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -178736,20 +223074,32 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sessions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSession", + "x-Ed-Fi-domains": [ + "BellSchedule", + "SchoolCalendar", + "StudentAcademicRecord", + "StudentAttendance", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sessions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSessionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -178764,18 +223114,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Session" - } - } - }, - "description": "The JSON representation of the Session resource to be created or updated.", - "required": true, - "x-bodyName": "Session" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -178793,7 +223131,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sessions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSessionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Session" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sessions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSession", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Session" + } + } + }, + "description": "The JSON representation of the Session resource to be created or updated.", + "required": true, + "x-bodyName": "Session" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179036,6 +223489,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SexDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SexDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SexDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -179152,7 +223666,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179195,7 +223709,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179215,27 +223729,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/sexDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSexesById", + "/ed-fi/sexDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSexesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -179249,48 +223776,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sexDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sexDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSexesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSexesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -179298,14 +223814,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SexDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -179317,20 +223833,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sexDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSex", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sexDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSexesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -179345,18 +223865,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SexDescriptor" - } - } - }, - "description": "The JSON representation of the Sex resource to be created or updated.", - "required": true, - "x-bodyName": "Sex" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -179374,7 +223882,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sexDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSexesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SexDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sexDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSex", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SexDescriptor" + } + } + }, + "description": "The JSON representation of the Sex resource to be created or updated.", + "required": true, + "x-bodyName": "Sex" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179661,6 +224284,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_SourceDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SourceDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_SourceDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -179750,7 +224434,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179793,7 +224477,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179814,27 +224498,40 @@ "Finance" ] }, - "/ed-fi/sourceDimensions/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSourceDimensionsById", + "/ed-fi/sourceDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSourceDimensionsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -179848,48 +224545,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sourceDimensions" ] }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/sourceDimensions/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSourceDimensionsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSourceDimensionsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -179897,14 +224584,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SourceDimension" + "items": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -179916,20 +224603,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sourceDimensions" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSourceDimension", + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/sourceDimensions/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSourceDimensionsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -179944,18 +224636,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SourceDimension" - } - } - }, - "description": "The JSON representation of the SourceDimension resource to be created or updated.", - "required": true, - "x-bodyName": "SourceDimension" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -179973,7 +224653,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sourceDimensions" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSourceDimensionsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SourceDimension" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sourceDimensions" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSourceDimension", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SourceDimension" + } + } + }, + "description": "The JSON representation of the SourceDimension resource to be created or updated.", + "required": true, + "x-bodyName": "SourceDimension" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180180,6 +224975,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SourceSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SourceSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SourceSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -180296,7 +225152,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180339,7 +225195,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180359,27 +225215,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/sourceSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSourceSystemsById", + "/ed-fi/sourceSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSourceSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -180393,48 +225262,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "sourceSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sourceSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSourceSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSourceSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -180442,14 +225300,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -180461,20 +225319,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "sourceSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSourceSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/sourceSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSourceSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -180489,18 +225351,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor" - } - } - }, - "description": "The JSON representation of the SourceSystem resource to be created or updated.", - "required": true, - "x-bodyName": "SourceSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -180518,7 +225368,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "sourceSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSourceSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "sourceSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSourceSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor" + } + } + }, + "description": "The JSON representation of the SourceSystem resource to be created or updated.", + "required": true, + "x-bodyName": "SourceSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180743,6 +225708,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -180859,7 +225885,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180902,7 +225928,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180922,27 +225948,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/specialEducationExitReasonDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSpecialEducationExitReasonsById", + "/ed-fi/specialEducationExitReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationExitReasonsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -180956,48 +225995,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "specialEducationExitReasonDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationExitReasonDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSpecialEducationExitReasonsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationExitReasonsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -181005,14 +226033,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -181024,20 +226052,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "specialEducationExitReasonDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSpecialEducationExitReason", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationExitReasonDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSpecialEducationExitReasonsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -181052,18 +226084,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor" - } - } - }, - "description": "The JSON representation of the SpecialEducationExitReason resource to be created or updated.", - "required": true, - "x-bodyName": "SpecialEducationExitReason" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -181081,7 +226101,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "specialEducationExitReasonDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSpecialEducationExitReasonsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "specialEducationExitReasonDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSpecialEducationExitReason", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor" + } + } + }, + "description": "The JSON representation of the SpecialEducationExitReason resource to be created or updated.", + "required": true, + "x-bodyName": "SpecialEducationExitReason" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181306,6 +226441,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -181422,7 +226618,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181465,7 +226661,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181485,27 +226681,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/specialEducationProgramServiceDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSpecialEducationProgramServicesById", + "/ed-fi/specialEducationProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationProgramServicesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -181519,48 +226728,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "specialEducationProgramServiceDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationProgramServiceDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSpecialEducationProgramServicesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationProgramServicesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -181568,14 +226766,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -181587,20 +226785,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "specialEducationProgramServiceDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSpecialEducationProgramService", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationProgramServiceDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSpecialEducationProgramServicesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -181615,18 +226817,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor" - } - } - }, - "description": "The JSON representation of the SpecialEducationProgramService resource to be created or updated.", - "required": true, - "x-bodyName": "SpecialEducationProgramService" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -181644,7 +226834,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "specialEducationProgramServiceDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSpecialEducationProgramServicesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "specialEducationProgramServiceDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSpecialEducationProgramService", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor" + } + } + }, + "description": "The JSON representation of the SpecialEducationProgramService resource to be created or updated.", + "required": true, + "x-bodyName": "SpecialEducationProgramService" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181869,6 +227174,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SpecialEducationSettingDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SpecialEducationSettingDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -181985,7 +227351,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182028,7 +227394,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -182048,27 +227414,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/specialEducationSettingDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteSpecialEducationSettingsById", + "/ed-fi/specialEducationSettingDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationSettingsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -182082,48 +227461,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "specialEducationSettingDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationSettingDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getSpecialEducationSettingsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationSettingsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -182131,14 +227499,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -182150,20 +227518,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "specialEducationSettingDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putSpecialEducationSetting", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/specialEducationSettingDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteSpecialEducationSettingsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -182178,18 +227550,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor" - } - } - }, - "description": "The JSON representation of the SpecialEducationSetting resource to be created or updated.", - "required": true, - "x-bodyName": "SpecialEducationSetting" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -182207,7 +227567,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "specialEducationSettingDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getSpecialEducationSettingsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "specialEducationSettingDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putSpecialEducationSetting", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor" + } + } + }, + "description": "The JSON representation of the SpecialEducationSetting resource to be created or updated.", + "required": true, + "x-bodyName": "SpecialEducationSetting" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -182502,6 +227977,72 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffAbsenceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffAbsenceEvent_TrackedChangeKey": { + "properties": { + "absenceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "absenceEventCategoryDescriptor", + "eventDate", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffAbsenceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -182610,7 +228151,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182653,7 +228194,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -182674,27 +228215,40 @@ "Staff" ] }, - "/ed-fi/staffAbsenceEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffAbsenceEventsById", + "/ed-fi/staffAbsenceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffAbsenceEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -182708,48 +228262,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffAbsenceEvents" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffAbsenceEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffAbsenceEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffAbsenceEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -182757,14 +228301,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent" + "items": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -182776,20 +228320,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffAbsenceEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffAbsenceEvent", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffAbsenceEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffAbsenceEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -182804,18 +228353,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent" - } - } - }, - "description": "The JSON representation of the StaffAbsenceEvent resource to be created or updated.", - "required": true, - "x-bodyName": "StaffAbsenceEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -182833,7 +228370,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffAbsenceEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffAbsenceEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffAbsenceEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffAbsenceEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent" + } + } + }, + "description": "The JSON representation of the StaffAbsenceEvent resource to be created or updated.", + "required": true, + "x-bodyName": "StaffAbsenceEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183053,6 +228705,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffClassificationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffClassificationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffClassificationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -183169,7 +228882,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183212,7 +228925,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183232,27 +228945,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/staffClassificationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffClassificationsById", + "/ed-fi/staffClassificationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffClassificationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -183266,48 +228992,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffClassificationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffClassificationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffClassificationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffClassificationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -183315,14 +229030,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -183334,20 +229049,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffClassificationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffClassification", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffClassificationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffClassificationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -183362,18 +229081,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor" - } - } - }, - "description": "The JSON representation of the StaffClassification resource to be created or updated.", - "required": true, - "x-bodyName": "StaffClassification" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -183391,7 +229098,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffClassificationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffClassificationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffClassificationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffClassification", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor" + } + } + }, + "description": "The JSON representation of the StaffClassification resource to be created or updated.", + "required": true, + "x-bodyName": "StaffClassification" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183714,6 +229536,77 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffCohortAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffCohortAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "cohortIdentifier": { + "maxLength": 36, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "cohortIdentifier", + "educationOrganizationId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffCohortAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -183831,7 +229724,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183874,7 +229767,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183895,27 +229788,40 @@ "StudentCohort" ] }, - "/ed-fi/staffCohortAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffCohortAssociationsById", + "/ed-fi/staffCohortAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffCohortAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -183929,48 +229835,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffCohortAssociations" ] }, + "x-Ed-Fi-domains": [ + "StudentCohort" + ] + }, + "/ed-fi/staffCohortAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffCohortAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffCohortAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -183978,14 +229874,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffCohortAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -183997,20 +229893,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffCohortAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffCohortAssociation", + "x-Ed-Fi-domains": [ + "StudentCohort" + ] + }, + "/ed-fi/staffCohortAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffCohortAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -184025,18 +229926,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffCohortAssociation" - } - } - }, - "description": "The JSON representation of the StaffCohortAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffCohortAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -184054,7 +229943,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffCohortAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffCohortAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffCohortAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffCohortAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation" + } + } + }, + "description": "The JSON representation of the StaffCohortAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffCohortAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -184374,6 +230378,72 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffDisciplineIncidentAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey": { + "properties": { + "incidentIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "incidentIdentifier", + "schoolId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -184464,7 +230534,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184507,7 +230577,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -184528,27 +230598,40 @@ "Discipline" ] }, - "/ed-fi/staffDisciplineIncidentAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffDisciplineIncidentAssociationsById", + "/ed-fi/staffDisciplineIncidentAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDisciplineIncidentAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -184562,48 +230645,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffDisciplineIncidentAssociations" ] }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/staffDisciplineIncidentAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffDisciplineIncidentAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDisciplineIncidentAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -184611,14 +230684,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -184630,20 +230703,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffDisciplineIncidentAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffDisciplineIncidentAssociation", + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/staffDisciplineIncidentAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffDisciplineIncidentAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -184658,18 +230736,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation" - } - } - }, - "description": "The JSON representation of the StaffDisciplineIncidentAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffDisciplineIncidentAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -184687,7 +230753,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffDisciplineIncidentAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffDisciplineIncidentAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffDisciplineIncidentAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffDisciplineIncidentAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation" + } + } + }, + "description": "The JSON representation of the StaffDisciplineIncidentAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffDisciplineIncidentAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -185171,6 +231352,77 @@ "staffClassificationDescriptor" ], "type": "object" + }, + "EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffClassificationDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "staffClassificationDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -185357,7 +231609,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -185400,7 +231652,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -185422,27 +231674,40 @@ "TeacherPreparation" ] }, - "/ed-fi/staffEducationOrganizationAssignmentAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffEducationOrganizationAssignmentAssociationsById", + "/ed-fi/staffEducationOrganizationAssignmentAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationAssignmentAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -185456,48 +231721,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffEducationOrganizationAssignmentAssociations" ] }, + "x-Ed-Fi-domains": [ + "Staff", + "TeacherPreparation" + ] + }, + "/ed-fi/staffEducationOrganizationAssignmentAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffEducationOrganizationAssignmentAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationAssignmentAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -185505,14 +231761,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -185524,20 +231780,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffEducationOrganizationAssignmentAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffEducationOrganizationAssignmentAssociation", + "x-Ed-Fi-domains": [ + "Staff", + "TeacherPreparation" + ] + }, + "/ed-fi/staffEducationOrganizationAssignmentAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffEducationOrganizationAssignmentAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -185552,18 +231814,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation" - } - } - }, - "description": "The JSON representation of the StaffEducationOrganizationAssignmentAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffEducationOrganizationAssignmentAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -185581,7 +231831,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffEducationOrganizationAssignmentAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffEducationOrganizationAssignmentAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffEducationOrganizationAssignmentAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffEducationOrganizationAssignmentAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation" + } + } + }, + "description": "The JSON representation of the StaffEducationOrganizationAssignmentAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffEducationOrganizationAssignmentAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -186438,6 +232803,72 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKey": { + "properties": { + "contactTitle": { + "maxLength": 75, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "contactTitle", + "educationOrganizationId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -186547,7 +232978,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -186590,7 +233021,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -186611,27 +233042,40 @@ "Staff" ] }, - "/ed-fi/staffEducationOrganizationContactAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffEducationOrganizationContactAssociationsById", + "/ed-fi/staffEducationOrganizationContactAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationContactAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -186645,48 +233089,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffEducationOrganizationContactAssociations" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationContactAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffEducationOrganizationContactAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationContactAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -186694,14 +233128,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -186713,20 +233147,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffEducationOrganizationContactAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffEducationOrganizationContactAssociation", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationContactAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffEducationOrganizationContactAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -186741,18 +233180,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation" - } - } - }, - "description": "The JSON representation of the StaffEducationOrganizationContactAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffEducationOrganizationContactAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -186770,7 +233197,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffEducationOrganizationContactAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffEducationOrganizationContactAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffEducationOrganizationContactAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffEducationOrganizationContactAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationContactAssociation" + } + } + }, + "description": "The JSON representation of the StaffEducationOrganizationContactAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffEducationOrganizationContactAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -187280,6 +233822,77 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "employmentStatusDescriptor": { + "maxLength": 306, + "type": "string" + }, + "hireDate": { + "format": "date", + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "employmentStatusDescriptor", + "hireDate", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -187472,7 +234085,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -187515,7 +234128,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -187536,27 +234149,40 @@ "Staff" ] }, - "/ed-fi/staffEducationOrganizationEmploymentAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffEducationOrganizationEmploymentAssociationsById", + "/ed-fi/staffEducationOrganizationEmploymentAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationEmploymentAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -187570,48 +234196,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffEducationOrganizationEmploymentAssociations" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationEmploymentAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffEducationOrganizationEmploymentAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationEmploymentAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -187619,14 +234235,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -187638,20 +234254,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffEducationOrganizationEmploymentAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffEducationOrganizationEmploymentAssociation", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationEmploymentAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffEducationOrganizationEmploymentAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -187666,18 +234287,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation" - } - } - }, - "description": "The JSON representation of the StaffEducationOrganizationEmploymentAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffEducationOrganizationEmploymentAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -187695,7 +234304,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffEducationOrganizationEmploymentAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffEducationOrganizationEmploymentAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffEducationOrganizationEmploymentAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffEducationOrganizationEmploymentAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation" + } + } + }, + "description": "The JSON representation of the StaffEducationOrganizationEmploymentAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffEducationOrganizationEmploymentAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -187973,6 +234697,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -188089,7 +234874,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188132,7 +234917,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188152,27 +234937,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/staffIdentificationSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffIdentificationSystemsById", + "/ed-fi/staffIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffIdentificationSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -188186,48 +234984,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffIdentificationSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffIdentificationSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffIdentificationSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffIdentificationSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -188235,14 +235022,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -188254,20 +235041,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffIdentificationSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffIdentificationSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffIdentificationSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffIdentificationSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -188282,18 +235073,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor" - } - } - }, - "description": "The JSON representation of the StaffIdentificationSystem resource to be created or updated.", - "required": true, - "x-bodyName": "StaffIdentificationSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -188311,7 +235090,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffIdentificationSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffIdentificationSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffIdentificationSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffIdentificationSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor" + } + } + }, + "description": "The JSON representation of the StaffIdentificationSystem resource to be created or updated.", + "required": true, + "x-bodyName": "StaffIdentificationSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188536,6 +235430,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -188652,7 +235607,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188695,7 +235650,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188715,27 +235670,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/staffLeaveEventCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffLeaveEventCategoriesById", + "/ed-fi/staffLeaveEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeaveEventCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -188749,48 +235717,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffLeaveEventCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffLeaveEventCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffLeaveEventCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeaveEventCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -188798,14 +235755,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -188817,20 +235774,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffLeaveEventCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffLeaveEventCategory", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/staffLeaveEventCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffLeaveEventCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -188845,18 +235806,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the StaffLeaveEventCategory resource to be created or updated.", - "required": true, - "x-bodyName": "StaffLeaveEventCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -188874,7 +235823,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffLeaveEventCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffLeaveEventCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffLeaveEventCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffLeaveEventCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the StaffLeaveEventCategory resource to be created or updated.", + "required": true, + "x-bodyName": "StaffLeaveEventCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -189182,6 +236246,72 @@ "staffLeaveEventCategoryDescriptor" ], "type": "object" + }, + "EdFi_StaffLeave_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffLeave_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "staffLeaveEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "staffLeaveEventCategoryDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffLeave_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -189298,7 +236428,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -189341,7 +236471,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -189362,27 +236492,40 @@ "Staff" ] }, - "/ed-fi/staffLeaves/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffLeavesById", + "/ed-fi/staffLeaves/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeavesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -189396,48 +236539,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffLeaves" ] }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffLeaves/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffLeavesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeavesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -189445,14 +236578,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffLeave" + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -189464,20 +236597,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffLeaves" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffLeave", + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffLeaves/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffLeavesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -189492,18 +236630,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffLeave" - } - } - }, - "description": "The JSON representation of the StaffLeave resource to be created or updated.", - "required": true, - "x-bodyName": "StaffLeave" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -189521,7 +236647,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffLeaves" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffLeavesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffLeave" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffLeaves" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffLeave", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffLeave" + } + } + }, + "description": "The JSON representation of the StaffLeave resource to be created or updated.", + "required": true, + "x-bodyName": "StaffLeave" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -189867,6 +237108,82 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -189994,7 +237311,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190037,7 +237354,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -190061,27 +237378,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/staffProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffProgramAssociationsById", + "/ed-fi/staffProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -190095,48 +237425,41 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -190144,14 +237467,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -190163,20 +237486,28 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffProgramAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -190191,18 +237522,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffProgramAssociation" - } - } - }, - "description": "The JSON representation of the StaffProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -190220,7 +237539,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation" + } + } + }, + "description": "The JSON representation of the StaffProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -190718,6 +238152,72 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffSchoolAssociation_TrackedChangeKey": { + "properties": { + "programAssignmentDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "programAssignmentDescriptor", + "schoolId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -190827,7 +238327,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190870,7 +238370,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -190893,27 +238393,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/staffSchoolAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffSchoolAssociationsById", + "/ed-fi/staffSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSchoolAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -190927,48 +238440,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffSchoolAssociations" ] }, + "x-Ed-Fi-domains": [ + "Staff", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffSchoolAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffSchoolAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSchoolAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -190976,14 +238481,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -190995,20 +238500,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffSchoolAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffSchoolAssociation", + "x-Ed-Fi-domains": [ + "Staff", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffSchoolAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffSchoolAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -191023,18 +238535,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation" - } - } - }, - "description": "The JSON representation of the StaffSchoolAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffSchoolAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -191052,7 +238552,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffSchoolAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffSchoolAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffSchoolAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffSchoolAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation" + } + } + }, + "description": "The JSON representation of the StaffSchoolAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffSchoolAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191504,6 +239119,92 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffSectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffSectionAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffSectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -191677,7 +239378,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191720,7 +239421,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191744,27 +239445,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/staffSectionAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffSectionAssociationsById", + "/ed-fi/staffSectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSectionAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -191778,48 +239492,41 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffSectionAssociations" ] }, + "x-Ed-Fi-domains": [ + "SpecialEducation", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffSectionAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffSectionAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSectionAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -191827,14 +239534,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StaffSectionAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -191846,20 +239553,28 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffSectionAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaffSectionAssociation", + "x-Ed-Fi-domains": [ + "SpecialEducation", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffSectionAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffSectionAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -191874,18 +239589,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StaffSectionAssociation" - } - } - }, - "description": "The JSON representation of the StaffSectionAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StaffSectionAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -191903,7 +239606,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffSectionAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffSectionAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffSectionAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaffSectionAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation" + } + } + }, + "description": "The JSON representation of the StaffSectionAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StaffSectionAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -194631,6 +242449,62 @@ ], "type": "object" }, + "EdFi_Staff_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Staff_TrackedChangeKey": { + "properties": { + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_Staff_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_Staff_TribalAffiliation": { "properties": { "tribalAffiliationDescriptor": { @@ -194893,7 +242767,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194936,7 +242810,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -194967,27 +242841,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/staffs/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStaffsById", + "/ed-fi/staffs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -195001,48 +242888,48 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "staffs" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffs/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStaffsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -195050,14 +242937,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Staff" + "items": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -195069,20 +242956,35 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "staffs" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStaff", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffs/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStaffsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -195097,18 +242999,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Staff" - } - } - }, - "description": "The JSON representation of the Staff resource to be created or updated.", - "required": true, - "x-bodyName": "Staff" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -195126,7 +243016,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "staffs" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStaffsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Staff" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "staffs" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStaff", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Staff" + } + } + }, + "description": "The JSON representation of the Staff resource to be created or updated.", + "required": true, + "x-bodyName": "Staff" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -195461,6 +243466,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StateAbbreviationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StateAbbreviationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StateAbbreviationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -195577,7 +243643,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -195620,7 +243686,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -195640,27 +243706,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/stateAbbreviationDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStateAbbreviationsById", + "/ed-fi/stateAbbreviationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStateAbbreviationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -195674,48 +243753,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "stateAbbreviationDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/stateAbbreviationDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStateAbbreviationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStateAbbreviationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -195723,14 +243791,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -195742,20 +243810,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "stateAbbreviationDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStateAbbreviation", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/stateAbbreviationDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStateAbbreviationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -195770,18 +243842,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor" - } - } - }, - "description": "The JSON representation of the StateAbbreviation resource to be created or updated.", - "required": true, - "x-bodyName": "StateAbbreviation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -195799,7 +243859,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "stateAbbreviationDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStateAbbreviationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "stateAbbreviationDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStateAbbreviation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor" + } + } + }, + "description": "The JSON representation of the StateAbbreviation resource to be created or updated.", + "required": true, + "x-bodyName": "StateAbbreviation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -197225,6 +245400,62 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_StateEducationAgency_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StateEducationAgency_TrackedChangeKey": { + "properties": { + "stateEducationAgencyId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "stateEducationAgencyId" + ], + "type": "object" + }, + "EdFi_StateEducationAgency_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -197332,7 +245563,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -197375,7 +245606,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -197397,27 +245628,40 @@ "Staff" ] }, - "/ed-fi/stateEducationAgencies/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStateEducationAgenciesById", + "/ed-fi/stateEducationAgencies/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStateEducationAgenciesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -197431,48 +245675,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "stateEducationAgencies" ] }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, + "/ed-fi/stateEducationAgencies/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStateEducationAgenciesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStateEducationAgenciesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -197480,14 +245715,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StateEducationAgency" + "items": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -197499,20 +245734,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "stateEducationAgencies" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStateEducationAgency", + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, + "/ed-fi/stateEducationAgencies/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStateEducationAgenciesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -197527,18 +245768,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StateEducationAgency" - } - } - }, - "description": "The JSON representation of the StateEducationAgency resource to be created or updated.", - "required": true, - "x-bodyName": "StateEducationAgency" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -197556,7 +245785,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "stateEducationAgencies" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStateEducationAgenciesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "stateEducationAgencies" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStateEducationAgency", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency" + } + } + }, + "description": "The JSON representation of the StateEducationAgency resource to be created or updated.", + "required": true, + "x-bodyName": "StateEducationAgency" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -199406,6 +247750,77 @@ "reportCardReference" ], "type": "object" + }, + "EdFi_StudentAcademicRecord_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAcademicRecord_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "schoolYear", + "studentUniqueId", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_StudentAcademicRecord_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -199623,7 +248038,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199666,7 +248081,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -199690,27 +248105,40 @@ "StudentTranscript" ] }, - "/ed-fi/studentAcademicRecords/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentAcademicRecordsById", + "/ed-fi/studentAcademicRecords/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAcademicRecordsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -199724,48 +248152,41 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentAcademicRecords" ] }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/studentAcademicRecords/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentAcademicRecordsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAcademicRecordsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -199773,14 +248194,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentAcademicRecord" + "items": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -199792,20 +248213,28 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentAcademicRecords" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentAcademicRecord", + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/studentAcademicRecords/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentAcademicRecordsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -199820,18 +248249,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentAcademicRecord" - } - } - }, - "description": "The JSON representation of the StudentAcademicRecord resource to be created or updated.", - "required": true, - "x-bodyName": "StudentAcademicRecord" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -199849,7 +248266,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentAcademicRecords" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentAcademicRecordsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentAcademicRecords" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentAcademicRecord", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord" + } + } + }, + "description": "The JSON representation of the StudentAcademicRecord resource to be created or updated.", + "required": true, + "x-bodyName": "StudentAcademicRecord" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200289,6 +248821,88 @@ "studentAssessmentIdentifier" ], "type": "object" + }, + "EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "educationOrganizationAssociationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentAssessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "educationOrganizationAssociationTypeDescriptor", + "educationOrganizationId", + "namespace", + "studentAssessmentIdentifier", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -200419,7 +249033,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200462,7 +249076,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200483,27 +249097,40 @@ "Assessment" ] }, - "/ed-fi/studentAssessmentEducationOrganizationAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentAssessmentEducationOrganizationAssociationsById", + "/ed-fi/studentAssessmentEducationOrganizationAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentEducationOrganizationAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -200517,48 +249144,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentAssessmentEducationOrganizationAssociations" ] }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, + "/ed-fi/studentAssessmentEducationOrganizationAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentAssessmentEducationOrganizationAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentEducationOrganizationAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -200566,14 +249183,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -200585,20 +249202,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentAssessmentEducationOrganizationAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentAssessmentEducationOrganizationAssociation", + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, + "/ed-fi/studentAssessmentEducationOrganizationAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentAssessmentEducationOrganizationAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -200613,18 +249235,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation" - } - } - }, - "description": "The JSON representation of the StudentAssessmentEducationOrganizationAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentAssessmentEducationOrganizationAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -200642,7 +249252,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentAssessmentEducationOrganizationAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentAssessmentEducationOrganizationAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentAssessmentEducationOrganizationAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentAssessmentEducationOrganizationAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation" + } + } + }, + "description": "The JSON representation of the StudentAssessmentEducationOrganizationAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentAssessmentEducationOrganizationAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -201084,6 +249809,93 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKey": { + "properties": { + "administrationIdentifier": { + "maxLength": 255, + "type": "string" + }, + "assessmentBatteryPartName": { + "maxLength": 65, + "type": "string" + }, + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "assigningEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "administrationIdentifier", + "assessmentBatteryPartName", + "assessmentIdentifier", + "assigningEducationOrganizationId", + "educationOrganizationId", + "namespace", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -201215,7 +250027,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -201258,7 +250070,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -201279,27 +250091,40 @@ "AssessmentRegistration" ] }, - "/ed-fi/studentAssessmentRegistrationBatteryPartAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentAssessmentRegistrationBatteryPartAssociationsById", + "/ed-fi/studentAssessmentRegistrationBatteryPartAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentRegistrationBatteryPartAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -201313,48 +250138,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentAssessmentRegistrationBatteryPartAssociations" ] }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/studentAssessmentRegistrationBatteryPartAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentAssessmentRegistrationBatteryPartAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentRegistrationBatteryPartAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -201362,14 +250177,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -201381,20 +250196,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentAssessmentRegistrationBatteryPartAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentAssessmentRegistrationBatteryPartAssociation", + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/studentAssessmentRegistrationBatteryPartAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentAssessmentRegistrationBatteryPartAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -201409,18 +250229,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation" - } - } - }, - "description": "The JSON representation of the StudentAssessmentRegistrationBatteryPartAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentAssessmentRegistrationBatteryPartAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -201438,7 +250246,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentAssessmentRegistrationBatteryPartAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentAssessmentRegistrationBatteryPartAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentAssessmentRegistrationBatteryPartAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentAssessmentRegistrationBatteryPartAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation" + } + } + }, + "description": "The JSON representation of the StudentAssessmentRegistrationBatteryPartAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentAssessmentRegistrationBatteryPartAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -202118,6 +251041,88 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentAssessmentRegistration_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAssessmentRegistration_TrackedChangeKey": { + "properties": { + "administrationIdentifier": { + "maxLength": 255, + "type": "string" + }, + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "assigningEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "administrationIdentifier", + "assessmentIdentifier", + "assigningEducationOrganizationId", + "educationOrganizationId", + "namespace", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentAssessmentRegistration_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -202317,7 +251322,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -202360,7 +251365,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -202381,27 +251386,40 @@ "AssessmentRegistration" ] }, - "/ed-fi/studentAssessmentRegistrations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentAssessmentRegistrationsById", + "/ed-fi/studentAssessmentRegistrations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentRegistrationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -202415,48 +251433,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentAssessmentRegistrations" ] }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/studentAssessmentRegistrations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentAssessmentRegistrationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentRegistrationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -202464,14 +251472,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration" + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -202483,20 +251491,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentAssessmentRegistrations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentAssessmentRegistration", + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/studentAssessmentRegistrations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentAssessmentRegistrationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -202511,18 +251524,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration" - } - } - }, - "description": "The JSON representation of the StudentAssessmentRegistration resource to be created or updated.", - "required": true, - "x-bodyName": "StudentAssessmentRegistration" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -202540,7 +251541,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentAssessmentRegistrations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentAssessmentRegistrationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentAssessmentRegistrations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentAssessmentRegistration", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration" + } + } + }, + "description": "The JSON representation of the StudentAssessmentRegistration resource to be created or updated.", + "required": true, + "x-bodyName": "StudentAssessmentRegistration" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -204094,6 +253210,78 @@ "objectiveAssessmentReference" ], "type": "object" + }, + "EdFi_StudentAssessment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAssessment_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentAssessmentIdentifier": { + "maxLength": 60, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "namespace", + "studentAssessmentIdentifier", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentAssessment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -204331,7 +253519,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204374,7 +253562,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -204396,27 +253584,40 @@ "StudentAssessment" ] }, - "/ed-fi/studentAssessments/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentAssessmentsById", + "/ed-fi/studentAssessments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -204430,48 +253631,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentAssessments" ] }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/studentAssessments/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentAssessmentsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -204479,14 +253671,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentAssessment" + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -204498,20 +253690,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentAssessments" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentAssessment", + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/studentAssessments/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentAssessmentsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -204526,18 +253724,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentAssessment" - } - } - }, - "description": "The JSON representation of the StudentAssessment resource to be created or updated.", - "required": true, - "x-bodyName": "StudentAssessment" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -204555,7 +253741,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentAssessments" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentAssessmentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAssessment" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentAssessments" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentAssessment", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentAssessment" + } + } + }, + "description": "The JSON representation of the StudentAssessment resource to be created or updated.", + "required": true, + "x-bodyName": "StudentAssessment" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -205351,6 +254652,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentCteProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCteProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentCteProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -205522,7 +254904,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205565,7 +254947,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -205586,27 +254968,40 @@ "AlternativeAndSupplementalServices" ] }, - "/ed-fi/studentCTEProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentCTEProgramAssociationsById", + "/ed-fi/studentCTEProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCTEProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -205620,48 +255015,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentCTEProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentCTEProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentCTEProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCTEProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -205669,14 +255054,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -205688,20 +255073,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentCTEProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentCTEProgramAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentCTEProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentCTEProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -205716,18 +255106,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentCTEProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentCTEProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -205745,7 +255123,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentCTEProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentCTEProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentCTEProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentCTEProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentCTEProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentCTEProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206019,6 +255512,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StudentCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StudentCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -206135,7 +255689,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206178,7 +255732,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206198,27 +255752,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentCharacteristicDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentCharacteristicsById", + "/ed-fi/studentCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCharacteristicsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -206232,48 +255799,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentCharacteristicDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentCharacteristicDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentCharacteristicsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCharacteristicsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -206281,14 +255837,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -206300,20 +255856,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentCharacteristicDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentCharacteristic", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentCharacteristicDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentCharacteristicsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -206328,18 +255888,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor" - } - } - }, - "description": "The JSON representation of the StudentCharacteristic resource to be created or updated.", - "required": true, - "x-bodyName": "StudentCharacteristic" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -206357,7 +255905,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentCharacteristicDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentCharacteristicsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentCharacteristicDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentCharacteristic", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor" + } + } + }, + "description": "The JSON representation of the StudentCharacteristic resource to be created or updated.", + "required": true, + "x-bodyName": "StudentCharacteristic" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206776,6 +256439,77 @@ "sectionReference" ], "type": "object" + }, + "EdFi_StudentCohortAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCohortAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "cohortIdentifier": { + "maxLength": 36, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "cohortIdentifier", + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentCohortAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -206885,7 +256619,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206928,7 +256662,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206950,27 +256684,40 @@ "StudentCohort" ] }, - "/ed-fi/studentCohortAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentCohortAssociationsById", + "/ed-fi/studentCohortAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCohortAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -206984,48 +256731,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentCohortAssociations" ] }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/studentCohortAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentCohortAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCohortAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -207033,14 +256771,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentCohortAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -207052,20 +256790,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentCohortAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentCohortAssociation", + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/studentCohortAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentCohortAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -207080,18 +256824,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentCohortAssociation" - } - } - }, - "description": "The JSON representation of the StudentCohortAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentCohortAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -207109,7 +256841,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentCohortAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentCohortAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentCohortAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentCohortAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation" + } + } + }, + "description": "The JSON representation of the StudentCohortAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentCohortAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -207782,6 +257629,97 @@ "studentSectionAssociationReference" ], "type": "object" + }, + "EdFi_StudentCompetencyObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCompetencyObjective_TrackedChangeKey": { + "properties": { + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "type": "string" + }, + "gradingPeriodSchoolId": { + "format": "int64", + "type": "integer" + }, + "gradingPeriodSchoolYear": { + "format": "int32", + "type": "integer" + }, + "objective": { + "maxLength": 60, + "type": "string" + }, + "objectiveEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "objectiveGradeLevelDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolId", + "gradingPeriodSchoolYear", + "objective", + "objectiveEducationOrganizationId", + "objectiveGradeLevelDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentCompetencyObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -207940,7 +257878,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207983,7 +257921,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -208005,27 +257943,40 @@ "ReportCard" ] }, - "/ed-fi/studentCompetencyObjectives/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentCompetencyObjectivesById", + "/ed-fi/studentCompetencyObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCompetencyObjectivesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -208039,48 +257990,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentCompetencyObjectives" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/studentCompetencyObjectives/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentCompetencyObjectivesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCompetencyObjectivesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -208088,14 +258030,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective" + "items": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -208107,20 +258049,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentCompetencyObjectives" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentCompetencyObjective", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/studentCompetencyObjectives/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentCompetencyObjectivesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -208135,18 +258083,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective" - } - } - }, - "description": "The JSON representation of the StudentCompetencyObjective resource to be created or updated.", - "required": true, - "x-bodyName": "StudentCompetencyObjective" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -208164,7 +258100,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentCompetencyObjectives" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentCompetencyObjectivesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentCompetencyObjectives" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentCompetencyObjective", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective" + } + } + }, + "description": "The JSON representation of the StudentCompetencyObjective resource to be created or updated.", + "required": true, + "x-bodyName": "StudentCompetencyObjective" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -208561,6 +258612,67 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentContactAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentContactAssociation_TrackedChangeKey": { + "properties": { + "contactUniqueId": { + "maxLength": 32, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "contactUniqueId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentContactAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -208700,7 +258812,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -208743,7 +258855,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -208764,27 +258876,40 @@ "StudentIdentificationAndDemographics" ] }, - "/ed-fi/studentContactAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentContactAssociationsById", + "/ed-fi/studentContactAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentContactAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -208798,48 +258923,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentContactAssociations" ] }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentContactAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentContactAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentContactAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -208847,14 +258962,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentContactAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -208866,20 +258981,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentContactAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentContactAssociation", + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentContactAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentContactAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -208894,18 +259014,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentContactAssociation" - } - } - }, - "description": "The JSON representation of the StudentContactAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentContactAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -208923,7 +259031,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentContactAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentContactAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentContactAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentContactAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation" + } + } + }, + "description": "The JSON representation of the StudentContactAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentContactAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209348,6 +259571,77 @@ ], "type": "object" }, + "EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey": { + "properties": { + "behaviorDescriptor": { + "maxLength": 306, + "type": "string" + }, + "incidentIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "behaviorDescriptor", + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_StudentDisciplineIncidentBehaviorAssociation_Weapon": { "properties": { "weaponDescriptor": { @@ -209469,7 +259763,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209512,7 +259806,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209533,27 +259827,40 @@ "Discipline" ] }, - "/ed-fi/studentDisciplineIncidentBehaviorAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentDisciplineIncidentBehaviorAssociationsById", + "/ed-fi/studentDisciplineIncidentBehaviorAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentBehaviorAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -209567,48 +259874,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentDisciplineIncidentBehaviorAssociations" ] }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/studentDisciplineIncidentBehaviorAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentDisciplineIncidentBehaviorAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentBehaviorAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -209616,14 +259913,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -209635,20 +259932,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentDisciplineIncidentBehaviorAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentDisciplineIncidentBehaviorAssociation", + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/studentDisciplineIncidentBehaviorAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentDisciplineIncidentBehaviorAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -209663,18 +259965,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation" - } - } - }, - "description": "The JSON representation of the StudentDisciplineIncidentBehaviorAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentDisciplineIncidentBehaviorAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -209692,7 +259982,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentDisciplineIncidentBehaviorAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentDisciplineIncidentBehaviorAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentDisciplineIncidentBehaviorAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentDisciplineIncidentBehaviorAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation" + } + } + }, + "description": "The JSON representation of the StudentDisciplineIncidentBehaviorAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentDisciplineIncidentBehaviorAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -210004,6 +260409,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey": { + "properties": { + "incidentIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -210094,7 +260565,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -210137,7 +260608,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -210158,27 +260629,40 @@ "Discipline" ] }, - "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentDisciplineIncidentNonOffenderAssociationsById", + "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentNonOffenderAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -210192,48 +260676,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentDisciplineIncidentNonOffenderAssociations" ] }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentDisciplineIncidentNonOffenderAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentNonOffenderAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -210241,14 +260715,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -210260,20 +260734,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentDisciplineIncidentNonOffenderAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentDisciplineIncidentNonOffenderAssociation", + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentDisciplineIncidentNonOffenderAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -210288,18 +260767,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation" - } - } - }, - "description": "The JSON representation of the StudentDisciplineIncidentNonOffenderAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentDisciplineIncidentNonOffenderAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -210317,7 +260784,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentDisciplineIncidentNonOffenderAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentDisciplineIncidentNonOffenderAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentDisciplineIncidentNonOffenderAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentDisciplineIncidentNonOffenderAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation" + } + } + }, + "description": "The JSON representation of the StudentDisciplineIncidentNonOffenderAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentDisciplineIncidentNonOffenderAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -210597,6 +261179,67 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -210677,7 +261320,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -210720,7 +261363,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -210741,27 +261384,40 @@ "AssessmentRegistration" ] }, - "/ed-fi/studentEducationOrganizationAssessmentAccommodations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentEducationOrganizationAssessmentAccommodationsById", + "/ed-fi/studentEducationOrganizationAssessmentAccommodations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationAssessmentAccommodationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -210775,48 +261431,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentEducationOrganizationAssessmentAccommodations" ] }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/studentEducationOrganizationAssessmentAccommodations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentEducationOrganizationAssessmentAccommodationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationAssessmentAccommodationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -210824,14 +261470,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -210843,20 +261489,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentEducationOrganizationAssessmentAccommodations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentEducationOrganizationAssessmentAccommodation", + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/studentEducationOrganizationAssessmentAccommodations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentEducationOrganizationAssessmentAccommodationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -210871,18 +261522,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation" - } - } - }, - "description": "The JSON representation of the StudentEducationOrganizationAssessmentAccommodation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentEducationOrganizationAssessmentAccommodation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -210900,7 +261539,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentEducationOrganizationAssessmentAccommodations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentEducationOrganizationAssessmentAccommodationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentEducationOrganizationAssessmentAccommodations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentEducationOrganizationAssessmentAccommodation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation" + } + } + }, + "description": "The JSON representation of the StudentEducationOrganizationAssessmentAccommodation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentEducationOrganizationAssessmentAccommodation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -213336,6 +264090,67 @@ ], "type": "object" }, + "EdFi_StudentEducationOrganizationAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_StudentEducationOrganizationAssociation_TribalAffiliation": { "properties": { "tribalAffiliationDescriptor": { @@ -213552,7 +264367,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -213595,7 +264410,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -213617,27 +264432,40 @@ "StudentIdentificationAndDemographics" ] }, - "/ed-fi/studentEducationOrganizationAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentEducationOrganizationAssociationsById", + "/ed-fi/studentEducationOrganizationAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -213651,48 +264479,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentEducationOrganizationAssociations" ] }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentEducationOrganizationAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentEducationOrganizationAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -213700,14 +264519,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -213719,20 +264538,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentEducationOrganizationAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentEducationOrganizationAssociation", + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentEducationOrganizationAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentEducationOrganizationAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -213747,18 +264572,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation" - } - } - }, - "description": "The JSON representation of the StudentEducationOrganizationAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentEducationOrganizationAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -213776,7 +264589,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentEducationOrganizationAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentEducationOrganizationAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentEducationOrganizationAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentEducationOrganizationAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation" + } + } + }, + "description": "The JSON representation of the StudentEducationOrganizationAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentEducationOrganizationAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214160,6 +265088,77 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "responsibilityDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "responsibilityDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -214269,7 +265268,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214312,7 +265311,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214333,27 +265332,40 @@ "Enrollment" ] }, - "/ed-fi/studentEducationOrganizationResponsibilityAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentEducationOrganizationResponsibilityAssociationsById", + "/ed-fi/studentEducationOrganizationResponsibilityAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationResponsibilityAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -214367,48 +265379,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentEducationOrganizationResponsibilityAssociations" ] }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/studentEducationOrganizationResponsibilityAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentEducationOrganizationResponsibilityAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationResponsibilityAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -214416,14 +265418,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -214435,20 +265437,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentEducationOrganizationResponsibilityAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentEducationOrganizationResponsibilityAssociation", + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/studentEducationOrganizationResponsibilityAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentEducationOrganizationResponsibilityAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -214463,18 +265470,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation" - } - } - }, - "description": "The JSON representation of the StudentEducationOrganizationResponsibilityAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentEducationOrganizationResponsibilityAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -214492,7 +265487,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentEducationOrganizationResponsibilityAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentEducationOrganizationResponsibilityAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentEducationOrganizationResponsibilityAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentEducationOrganizationResponsibilityAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation" + } + } + }, + "description": "The JSON representation of the StudentEducationOrganizationResponsibilityAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentEducationOrganizationResponsibilityAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214934,6 +266044,73 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentGradebookEntry_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentGradebookEntry_TrackedChangeKey": { + "properties": { + "gradebookEntryIdentifier": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "gradebookEntryIdentifier", + "namespace", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentGradebookEntry_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -215105,7 +266282,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215148,7 +266325,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -215170,27 +266347,40 @@ "Gradebook" ] }, - "/ed-fi/studentGradebookEntries/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentGradebookEntriesById", + "/ed-fi/studentGradebookEntries/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentGradebookEntriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -215204,48 +266394,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentGradebookEntries" ] }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/studentGradebookEntries/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentGradebookEntriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentGradebookEntriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -215253,14 +266434,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentGradebookEntry" + "items": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -215272,20 +266453,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentGradebookEntries" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentGradebookEntry", + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/studentGradebookEntries/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentGradebookEntriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -215300,18 +266487,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentGradebookEntry" - } - } - }, - "description": "The JSON representation of the StudentGradebookEntry resource to be created or updated.", - "required": true, - "x-bodyName": "StudentGradebookEntry" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -215329,7 +266504,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentGradebookEntries" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentGradebookEntriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentGradebookEntries" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentGradebookEntry", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry" + } + } + }, + "description": "The JSON representation of the StudentGradebookEntry resource to be created or updated.", + "required": true, + "x-bodyName": "StudentGradebookEntry" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -215910,6 +267200,67 @@ "immunizationTypeDescriptor" ], "type": "object" + }, + "EdFi_StudentHealth_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentHealth_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentHealth_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -216017,7 +267368,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -216060,7 +267411,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -216081,27 +267432,40 @@ "StudentHealth" ] }, - "/ed-fi/studentHealths/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentHealthsById", + "/ed-fi/studentHealths/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHealthsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -216115,48 +267479,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentHealths" ] }, + "x-Ed-Fi-domains": [ + "StudentHealth" + ] + }, + "/ed-fi/studentHealths/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentHealthsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHealthsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -216164,14 +267518,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentHealth" + "items": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -216183,20 +267537,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentHealths" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentHealth", + "x-Ed-Fi-domains": [ + "StudentHealth" + ] + }, + "/ed-fi/studentHealths/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentHealthsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -216211,18 +267570,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentHealth" - } - } - }, - "description": "The JSON representation of the StudentHealth resource to be created or updated.", - "required": true, - "x-bodyName": "StudentHealth" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -216240,7 +267587,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentHealths" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentHealthsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentHealth" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentHealths" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentHealth", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentHealth" + } + } + }, + "description": "The JSON representation of the StudentHealth resource to be created or updated.", + "required": true, + "x-bodyName": "StudentHealth" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -216930,6 +268392,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentHomelessProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentHomelessProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentHomelessProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -217101,7 +268644,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217144,7 +268687,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -217165,27 +268708,40 @@ "AlternativeAndSupplementalServices" ] }, - "/ed-fi/studentHomelessProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentHomelessProgramAssociationsById", + "/ed-fi/studentHomelessProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHomelessProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -217199,48 +268755,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentHomelessProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentHomelessProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentHomelessProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHomelessProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -217248,14 +268794,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -217267,20 +268813,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentHomelessProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentHomelessProgramAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentHomelessProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentHomelessProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -217295,18 +268846,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentHomelessProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentHomelessProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -217324,7 +268863,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentHomelessProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentHomelessProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentHomelessProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentHomelessProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentHomelessProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentHomelessProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -217598,6 +269252,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StudentIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -217714,7 +269429,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217757,7 +269472,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -217777,27 +269492,40 @@ "x-Ed-Fi-domains": [ ] }, - "/ed-fi/studentIdentificationSystemDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentIdentificationSystemsById", + "/ed-fi/studentIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIdentificationSystemsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -217811,48 +269539,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentIdentificationSystemDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentIdentificationSystemDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentIdentificationSystemsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIdentificationSystemsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -217860,14 +269577,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -217879,20 +269596,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentIdentificationSystemDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentIdentificationSystem", + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentIdentificationSystemDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentIdentificationSystemsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -217907,18 +269628,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor" - } - } - }, - "description": "The JSON representation of the StudentIdentificationSystem resource to be created or updated.", - "required": true, - "x-bodyName": "StudentIdentificationSystem" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -217936,7 +269645,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentIdentificationSystemDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentIdentificationSystemsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentIdentificationSystemDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentIdentificationSystem", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor" + } + } + }, + "description": "The JSON representation of the StudentIdentificationSystem resource to be created or updated.", + "required": true, + "x-bodyName": "StudentIdentificationSystem" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -218420,6 +270244,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentInterventionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentInterventionAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionIdentificationCode": { + "maxLength": 60, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionIdentificationCode", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentInterventionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -218548,7 +270438,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218591,7 +270481,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -218613,27 +270503,40 @@ "StudentCohort" ] }, - "/ed-fi/studentInterventionAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentInterventionAssociationsById", + "/ed-fi/studentInterventionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -218647,48 +270550,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentInterventionAssociations" ] }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/studentInterventionAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentInterventionAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -218696,14 +270590,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -218715,20 +270609,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentInterventionAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentInterventionAssociation", + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/studentInterventionAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentInterventionAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -218743,18 +270643,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation" - } - } - }, - "description": "The JSON representation of the StudentInterventionAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentInterventionAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -218772,7 +270660,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentInterventionAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentInterventionAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentInterventionAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentInterventionAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation" + } + } + }, + "description": "The JSON representation of the StudentInterventionAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentInterventionAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -219192,6 +271195,82 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentInterventionAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "interventionIdentificationCode": { + "maxLength": 60, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "educationOrganizationId", + "eventDate", + "interventionIdentificationCode", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentInterventionAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -219338,7 +271417,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219381,7 +271460,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -219402,27 +271481,40 @@ "Intervention" ] }, - "/ed-fi/studentInterventionAttendanceEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentInterventionAttendanceEventsById", + "/ed-fi/studentInterventionAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAttendanceEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -219436,48 +271528,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentInterventionAttendanceEvents" ] }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/studentInterventionAttendanceEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentInterventionAttendanceEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAttendanceEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -219485,14 +271567,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent" + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -219504,20 +271586,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentInterventionAttendanceEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentInterventionAttendanceEvent", + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/studentInterventionAttendanceEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentInterventionAttendanceEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -219532,18 +271619,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent" - } - } - }, - "description": "The JSON representation of the StudentInterventionAttendanceEvent resource to be created or updated.", - "required": true, - "x-bodyName": "StudentInterventionAttendanceEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -219561,7 +271636,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentInterventionAttendanceEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentInterventionAttendanceEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentInterventionAttendanceEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentInterventionAttendanceEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent" + } + } + }, + "description": "The JSON representation of the StudentInterventionAttendanceEvent resource to be created or updated.", + "required": true, + "x-bodyName": "StudentInterventionAttendanceEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -220403,6 +272593,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -220566,7 +272837,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220609,7 +272880,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -220630,27 +272901,40 @@ "AlternativeAndSupplementalServices" ] }, - "/ed-fi/studentLanguageInstructionProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentLanguageInstructionProgramAssociationsById", + "/ed-fi/studentLanguageInstructionProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentLanguageInstructionProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -220664,48 +272948,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentLanguageInstructionProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentLanguageInstructionProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentLanguageInstructionProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentLanguageInstructionProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -220713,14 +272987,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -220732,20 +273006,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentLanguageInstructionProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentLanguageInstructionProgramAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentLanguageInstructionProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentLanguageInstructionProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -220760,18 +273039,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentLanguageInstructionProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentLanguageInstructionProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -220789,7 +273056,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentLanguageInstructionProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentLanguageInstructionProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentLanguageInstructionProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentLanguageInstructionProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentLanguageInstructionProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentLanguageInstructionProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -221635,6 +274017,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -221861,7 +274324,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -221904,7 +274367,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -221925,27 +274388,40 @@ "AlternativeAndSupplementalServices" ] }, - "/ed-fi/studentMigrantEducationProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentMigrantEducationProgramAssociationsById", + "/ed-fi/studentMigrantEducationProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentMigrantEducationProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -221959,48 +274435,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentMigrantEducationProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentMigrantEducationProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentMigrantEducationProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentMigrantEducationProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -222008,14 +274474,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -222027,20 +274493,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentMigrantEducationProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentMigrantEducationProgramAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentMigrantEducationProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentMigrantEducationProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -222055,18 +274526,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentMigrantEducationProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentMigrantEducationProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -222084,7 +274543,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentMigrantEducationProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentMigrantEducationProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentMigrantEducationProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentMigrantEducationProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentMigrantEducationProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentMigrantEducationProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -222862,6 +275436,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -223035,7 +275690,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223078,7 +275733,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -223099,27 +275754,40 @@ "AlternativeAndSupplementalServices" ] }, - "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentNeglectedOrDelinquentProgramAssociationsById", + "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentNeglectedOrDelinquentProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -223133,48 +275801,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentNeglectedOrDelinquentProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentNeglectedOrDelinquentProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentNeglectedOrDelinquentProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -223182,14 +275840,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -223201,20 +275859,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentNeglectedOrDelinquentProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentNeglectedOrDelinquentProgramAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentNeglectedOrDelinquentProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -223229,18 +275892,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentNeglectedOrDelinquentProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentNeglectedOrDelinquentProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -223258,7 +275909,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentNeglectedOrDelinquentProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentNeglectedOrDelinquentProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentNeglectedOrDelinquentProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentNeglectedOrDelinquentProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentNeglectedOrDelinquentProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentNeglectedOrDelinquentProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -223943,6 +276709,87 @@ "serviceDescriptor" ], "type": "object" + }, + "EdFi_StudentProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -224089,7 +276936,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224132,7 +276979,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -224159,27 +277006,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/studentProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentProgramAssociationsById", + "/ed-fi/studentProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -224193,48 +277053,44 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -224242,14 +277098,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -224261,20 +277117,31 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentProgramAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -224289,18 +277156,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -224318,7 +277173,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -224823,6 +277793,92 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentProgramAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentProgramAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "educationOrganizationId", + "eventDate", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentProgramAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -224989,7 +278045,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225032,7 +278088,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225055,27 +278111,40 @@ "StudentAttendance" ] }, - "/ed-fi/studentProgramAttendanceEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentProgramAttendanceEventsById", + "/ed-fi/studentProgramAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAttendanceEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -225089,48 +278158,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentProgramAttendanceEvents" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentProgramAttendanceEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentProgramAttendanceEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAttendanceEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -225138,14 +278199,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent" + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -225157,20 +278218,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentProgramAttendanceEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentProgramAttendanceEvent", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentProgramAttendanceEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentProgramAttendanceEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -225185,18 +278253,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent" - } - } - }, - "description": "The JSON representation of the StudentProgramAttendanceEvent resource to be created or updated.", - "required": true, - "x-bodyName": "StudentProgramAttendanceEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -225214,7 +278270,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentProgramAttendanceEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentProgramAttendanceEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentProgramAttendanceEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentProgramAttendanceEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent" + } + } + }, + "description": "The JSON representation of the StudentProgramAttendanceEvent resource to be created or updated.", + "required": true, + "x-bodyName": "StudentProgramAttendanceEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -226245,6 +279416,97 @@ "programEvaluationObjectiveReference" ], "type": "object" + }, + "EdFi_StudentProgramEvaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentProgramEvaluation_TrackedChangeKey": { + "properties": { + "evaluationDate": { + "format": "date", + "type": "string" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "evaluationDate", + "programEducationOrganizationId", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentProgramEvaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -226441,7 +279703,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226484,7 +279746,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -226505,27 +279767,40 @@ "StudentProgramEvaluation" ] }, - "/ed-fi/studentProgramEvaluations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentProgramEvaluationsById", + "/ed-fi/studentProgramEvaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramEvaluationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -226539,48 +279814,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentProgramEvaluations" ] }, + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/studentProgramEvaluations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentProgramEvaluationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramEvaluationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -226588,14 +279853,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -226607,20 +279872,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentProgramEvaluations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentProgramEvaluation", + "x-Ed-Fi-domains": [ + "StudentProgramEvaluation" + ] + }, + "/ed-fi/studentProgramEvaluations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentProgramEvaluationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -226635,18 +279905,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation" - } - } - }, - "description": "The JSON representation of the StudentProgramEvaluation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentProgramEvaluation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -226664,7 +279922,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentProgramEvaluations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentProgramEvaluationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentProgramEvaluations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentProgramEvaluation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation" + } + } + }, + "description": "The JSON representation of the StudentProgramEvaluation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentProgramEvaluation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -227676,6 +281049,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSchoolAssociation_TrackedChangeKey": { + "properties": { + "entryDate": { + "format": "date", + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "entryDate", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -227972,7 +281411,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -228015,7 +281454,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -228040,27 +281479,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/studentSchoolAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSchoolAssociationsById", + "/ed-fi/studentSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -228074,48 +281526,42 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSchoolAssociations" ] }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentSchoolAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSchoolAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -228123,14 +281569,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -228142,20 +281588,29 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSchoolAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSchoolAssociation", + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentSchoolAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSchoolAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -228170,18 +281625,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation" - } - } - }, - "description": "The JSON representation of the StudentSchoolAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSchoolAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -228199,7 +281642,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSchoolAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSchoolAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSchoolAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSchoolAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation" + } + } + }, + "description": "The JSON representation of the StudentSchoolAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSchoolAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -228841,6 +282399,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSchoolAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "eventDate", + "schoolId", + "schoolYear", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSchoolAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -229013,7 +282652,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229056,7 +282695,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229079,27 +282718,40 @@ "StudentAttendance" ] }, - "/ed-fi/studentSchoolAttendanceEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSchoolAttendanceEventsById", + "/ed-fi/studentSchoolAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAttendanceEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -229113,48 +282765,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSchoolAttendanceEvents" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentSchoolAttendanceEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSchoolAttendanceEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAttendanceEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -229162,14 +282806,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -229181,20 +282825,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSchoolAttendanceEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSchoolAttendanceEvent", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentSchoolAttendanceEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSchoolAttendanceEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -229209,18 +282860,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent" - } - } - }, - "description": "The JSON representation of the StudentSchoolAttendanceEvent resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSchoolAttendanceEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -229238,7 +282877,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSchoolAttendanceEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSchoolAttendanceEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSchoolAttendanceEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSchoolAttendanceEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent" + } + } + }, + "description": "The JSON representation of the StudentSchoolAttendanceEvent resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSchoolAttendanceEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229932,6 +283686,87 @@ "schoolFoodServiceProgramServiceDescriptor" ], "type": "object" + }, + "EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -230086,7 +283921,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230129,7 +283964,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230150,27 +283985,40 @@ "AlternativeAndSupplementalServices" ] }, - "/ed-fi/studentSchoolFoodServiceProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSchoolFoodServiceProgramAssociationsById", + "/ed-fi/studentSchoolFoodServiceProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolFoodServiceProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -230184,48 +284032,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSchoolFoodServiceProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentSchoolFoodServiceProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSchoolFoodServiceProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolFoodServiceProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -230233,14 +284071,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -230252,20 +284090,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSchoolFoodServiceProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSchoolFoodServiceProgramAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentSchoolFoodServiceProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSchoolFoodServiceProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -230280,18 +284123,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentSchoolFoodServiceProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSchoolFoodServiceProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -230309,7 +284140,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSchoolFoodServiceProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSchoolFoodServiceProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSchoolFoodServiceProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSchoolFoodServiceProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentSchoolFoodServiceProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSchoolFoodServiceProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230960,6 +284906,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSection504ProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSection504ProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSection504ProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -231149,7 +285176,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231192,7 +285219,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231213,27 +285240,40 @@ "AlternativeAndSupplementalServices" ] }, - "/ed-fi/studentSection504ProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSection504ProgramAssociationsById", + "/ed-fi/studentSection504ProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSection504ProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -231247,48 +285287,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSection504ProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentSection504ProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSection504ProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSection504ProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -231296,14 +285326,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -231315,20 +285345,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSection504ProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSection504ProgramAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentSection504ProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSection504ProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -231343,18 +285378,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentSection504ProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSection504ProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -231372,7 +285395,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSection504ProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSection504ProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSection504ProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSection504ProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentSection504ProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSection504ProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -232079,6 +286217,92 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSectionAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -232296,7 +286520,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232339,7 +286563,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -232368,27 +286592,40 @@ "SectionsAndPrograms" ] }, - "/ed-fi/studentSectionAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSectionAssociationsById", + "/ed-fi/studentSectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -232402,48 +286639,46 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSectionAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentSectionAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSectionAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -232451,14 +286686,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSectionAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -232470,20 +286705,33 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSectionAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSectionAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentSectionAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSectionAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -232498,18 +286746,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSectionAssociation" - } - } - }, - "description": "The JSON representation of the StudentSectionAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSectionAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -232527,7 +286763,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSectionAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSectionAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSectionAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSectionAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation" + } + } + }, + "description": "The JSON representation of the StudentSectionAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSectionAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -233195,6 +287546,97 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSectionAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSectionAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "eventDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSectionAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -233387,7 +287829,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233430,7 +287872,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -233453,27 +287895,40 @@ "StudentAttendance" ] }, - "/ed-fi/studentSectionAttendanceEvents/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSectionAttendanceEventsById", + "/ed-fi/studentSectionAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAttendanceEventsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -233487,48 +287942,40 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSectionAttendanceEvents" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentSectionAttendanceEvents/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSectionAttendanceEventsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAttendanceEventsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -233536,14 +287983,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -233555,20 +288002,27 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSectionAttendanceEvents" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSectionAttendanceEvent", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentSectionAttendanceEvents/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSectionAttendanceEventsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -233583,18 +288037,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent" - } - } - }, - "description": "The JSON representation of the StudentSectionAttendanceEvent resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSectionAttendanceEvent" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -233612,7 +288054,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSectionAttendanceEvents" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSectionAttendanceEventsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSectionAttendanceEvents" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSectionAttendanceEvent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent" + } + } + }, + "description": "The JSON representation of the StudentSectionAttendanceEvent resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSectionAttendanceEvent" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -234918,6 +289475,87 @@ "specialEducationProgramServiceDescriptor" ], "type": "object" + }, + "EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -235195,7 +289833,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235238,7 +289876,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235260,27 +289898,40 @@ "SpecialEducation" ] }, - "/ed-fi/studentSpecialEducationProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSpecialEducationProgramAssociationsById", + "/ed-fi/studentSpecialEducationProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -235294,48 +289945,39 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSpecialEducationProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation" + ] + }, + "/ed-fi/studentSpecialEducationProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSpecialEducationProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -235343,14 +289985,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -235362,20 +290004,26 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSpecialEducationProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSpecialEducationProgramAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation" + ] + }, + "/ed-fi/studentSpecialEducationProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSpecialEducationProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -235390,18 +290038,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentSpecialEducationProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSpecialEducationProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -235419,7 +290055,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSpecialEducationProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSpecialEducationProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSpecialEducationProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSpecialEducationProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentSpecialEducationProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSpecialEducationProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236181,6 +290932,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey": { + "properties": { + "consentToEvaluationReceivedDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "consentToEvaluationReceivedDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -236434,7 +291266,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236477,7 +291309,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236498,27 +291330,40 @@ "AlternativeAndSupplementalServices" ] }, - "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentSpecialEducationProgramEligibilityAssociationsById", + "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramEligibilityAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -236532,48 +291377,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSpecialEducationProgramEligibilityAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentSpecialEducationProgramEligibilityAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramEligibilityAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -236581,14 +291416,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -236600,20 +291435,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSpecialEducationProgramEligibilityAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentSpecialEducationProgramEligibilityAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentSpecialEducationProgramEligibilityAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -236628,18 +291468,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation" - } - } - }, - "description": "The JSON representation of the StudentSpecialEducationProgramEligibilityAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSpecialEducationProgramEligibilityAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -236657,7 +291485,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentSpecialEducationProgramEligibilityAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentSpecialEducationProgramEligibilityAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentSpecialEducationProgramEligibilityAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentSpecialEducationProgramEligibilityAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation" + } + } + }, + "description": "The JSON representation of the StudentSpecialEducationProgramEligibilityAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSpecialEducationProgramEligibilityAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237409,6 +292352,87 @@ "titleIPartAProgramServiceDescriptor" ], "type": "object" + }, + "EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -237564,7 +292588,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237607,7 +292631,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237628,27 +292652,40 @@ "AlternativeAndSupplementalServices" ] }, - "/ed-fi/studentTitleIPartAProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentTitleIPartAProgramAssociationsById", + "/ed-fi/studentTitleIPartAProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTitleIPartAProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -237662,48 +292699,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentTitleIPartAProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentTitleIPartAProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentTitleIPartAProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTitleIPartAProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -237711,14 +292738,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -237730,20 +292757,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentTitleIPartAProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentTitleIPartAProgramAssociation", + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentTitleIPartAProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentTitleIPartAProgramAssociationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -237758,18 +292790,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation" - } - } - }, - "description": "The JSON representation of the StudentTitleIPartAProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentTitleIPartAProgramAssociation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -237787,7 +292807,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentTitleIPartAProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentTitleIPartAProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentTitleIPartAProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentTitleIPartAProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentTitleIPartAProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentTitleIPartAProgramAssociation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238287,6 +293422,67 @@ ], "type": "object" }, + "EdFi_StudentTransportation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentTransportation_TrackedChangeKey": { + "properties": { + "studentUniqueId": { + "maxLength": 32, + "type": "string" + }, + "transportationEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "studentUniqueId", + "transportationEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_StudentTransportation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_StudentTransportation_TravelDayofWeek": { "properties": { "travelDayofWeekDescriptor": { @@ -238419,7 +293615,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238462,7 +293658,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238483,27 +293679,40 @@ "Enrollment" ] }, - "/ed-fi/studentTransportations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentTransportationsById", + "/ed-fi/studentTransportations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTransportationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -238517,48 +293726,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentTransportations" ] }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/studentTransportations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentTransportationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTransportationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -238566,14 +293765,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_StudentTransportation" + "items": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -238585,20 +293784,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentTransportations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudentTransportation", + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/studentTransportations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentTransportationsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -238613,18 +293817,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_StudentTransportation" - } - } - }, - "description": "The JSON representation of the StudentTransportation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentTransportation" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -238642,7 +293834,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "studentTransportations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentTransportationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentTransportation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "studentTransportations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudentTransportation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_StudentTransportation" + } + } + }, + "description": "The JSON representation of the StudentTransportation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentTransportation" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239746,6 +295053,62 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_Student_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Student_TrackedChangeKey": { + "properties": { + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_Student_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -239989,7 +295352,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240032,7 +295395,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240072,82 +295435,25 @@ "StudentTranscript" ] }, - "/ed-fi/students/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteStudentsById", + "/ed-fi/students/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Updated" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "404": { - "$ref": "#/components/responses/NotFound" - }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "$ref": "#/components/parameters/MaxChangeVersion" }, - "500": { - "$ref": "#/components/responses/Error" - } - }, - "summary": "Deletes an existing resource using the resource identifier.", - "tags": [ - "students" - ] - }, - "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getStudentsById", - "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/limit" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/offset" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -240155,68 +295461,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_Student" + "items": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeDelete" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" - }, - "500": { - "$ref": "#/components/responses/Error" - } - }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", - "tags": [ - "students" - ] - }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putStudent", - "parameters": [ - { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/If-Match" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_Student" - } - } - }, - "description": "The JSON representation of the Student resource to be created or updated.", - "required": true, - "x-bodyName": "Student" - }, - "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -240230,20 +295482,280 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Updates a resource based on the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "students" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "Enrollment", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/students/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "students" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "Enrollment", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/students/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteStudentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "students" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getStudentsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Student" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "students" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putStudent", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_Student" + } + } + }, + "description": "The JSON representation of the Student resource to be created or updated.", + "required": true, + "x-bodyName": "Student" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Updates a resource based on the resource identifier.", "tags": [ "students" ] @@ -240568,6 +296080,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SubmissionStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SubmissionStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SubmissionStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -240684,7 +296257,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240727,7 +296300,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240747,6 +296320,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/submissionStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSubmissionStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "submissionStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/submissionStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSubmissionStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "submissionStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/submissionStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -240782,7 +296473,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240814,15 +296505,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -240849,7 +296531,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240906,7 +296588,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241131,6 +296813,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -241247,7 +296990,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241290,7 +297033,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241310,6 +297053,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/supporterMilitaryConnectionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSupporterMilitaryConnectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "supporterMilitaryConnectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/supporterMilitaryConnectionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSupporterMilitaryConnectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "supporterMilitaryConnectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/supporterMilitaryConnectionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -241345,7 +297206,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241377,15 +297238,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -241412,7 +297264,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241469,7 +297321,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241694,6 +297546,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SurveyCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SurveyCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -241810,7 +297723,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241853,7 +297766,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241873,6 +297786,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/surveyCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/surveyCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/surveyCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -241908,7 +297939,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241940,15 +297971,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -241975,7 +297997,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242032,7 +298054,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242312,6 +298334,78 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_SurveyCourseAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyCourseAssociation_TrackedChangeKey": { + "properties": { + "courseCode": { + "maxLength": 60, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "courseCode", + "educationOrganizationId", + "namespace", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyCourseAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -242413,7 +298507,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242456,7 +298550,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242477,6 +298571,126 @@ "Survey" ] }, + "/ed-fi/surveyCourseAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCourseAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyCourseAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyCourseAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCourseAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyCourseAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyCourseAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -242512,7 +298726,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242544,15 +298758,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -242579,7 +298784,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242636,7 +298841,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242854,6 +299059,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SurveyLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SurveyLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -242970,7 +299236,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243013,7 +299279,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243033,6 +299299,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/surveyLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/surveyLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/surveyLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -243068,7 +299452,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243100,15 +299484,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -243135,7 +299510,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243192,7 +299567,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243491,6 +299866,83 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_SurveyProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyProgramAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "namespace", + "programName", + "programTypeDescriptor", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -243602,7 +300054,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243645,7 +300097,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243666,6 +300118,126 @@ "Survey" ] }, + "/ed-fi/surveyProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -243701,7 +300273,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243733,15 +300305,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -243768,7 +300331,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243825,7 +300388,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244417,6 +300980,78 @@ "surveyQuestionResponseValueIdentifier" ], "type": "object" + }, + "EdFi_SurveyQuestionResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyQuestionResponse_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "questionCode": { + "maxLength": 60, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "namespace", + "questionCode", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyQuestionResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -244535,7 +301170,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244578,7 +301213,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244599,6 +301234,126 @@ "Survey" ] }, + "/ed-fi/surveyQuestionResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyQuestionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyQuestionResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyQuestionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyQuestionResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -244634,7 +301389,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244666,15 +301421,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -244701,7 +301447,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244758,7 +301504,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245304,6 +302050,73 @@ "sortOrder" ], "type": "object" + }, + "EdFi_SurveyQuestion_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyQuestion_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "questionCode": { + "maxLength": 60, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "namespace", + "questionCode", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyQuestion_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -245423,7 +302236,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245466,7 +302279,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245487,6 +302300,126 @@ "Survey" ] }, + "/ed-fi/surveyQuestions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyQuestions" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyQuestions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyQuestions" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyQuestions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -245522,7 +302455,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245554,15 +302487,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -245589,7 +302513,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245646,7 +302570,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245928,6 +302852,78 @@ "surveyResponseIdentifier" ], "type": "object" + }, + "EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -246029,7 +303025,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246072,7 +303068,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246093,6 +303089,126 @@ "Survey" ] }, + "/ed-fi/surveyResponseEducationOrganizationTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseEducationOrganizationTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponseEducationOrganizationTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseEducationOrganizationTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponseEducationOrganizationTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -246128,7 +303244,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246160,15 +303276,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -246195,7 +303302,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246252,7 +303359,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246525,6 +303632,78 @@ "surveyResponseIdentifier" ], "type": "object" + }, + "EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "namespace", + "staffUniqueId", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -246626,7 +303805,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246669,7 +303848,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246690,6 +303869,126 @@ "Survey" ] }, + "/ed-fi/surveyResponseStaffTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseStaffTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponseStaffTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseStaffTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponseStaffTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -246725,7 +304024,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246757,15 +304056,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -246792,7 +304082,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246849,7 +304139,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247324,6 +304614,73 @@ "surveyLevelDescriptor" ], "type": "object" + }, + "EdFi_SurveyResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponse_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -247491,7 +304848,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247534,7 +304891,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247555,6 +304912,126 @@ "Survey" ] }, + "/ed-fi/surveyResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -247590,7 +305067,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247622,15 +305099,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -247657,7 +305125,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247714,7 +305182,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248088,6 +305556,93 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_SurveySectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionAssociation_TrackedChangeKey": { + "properties": { + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 60, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "localCourseCode", + "namespace", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveySectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -248219,7 +305774,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248262,7 +305817,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248283,6 +305838,126 @@ "Survey" ] }, + "/ed-fi/surveySectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -248318,7 +305993,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248350,15 +306025,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -248385,7 +306051,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248442,7 +306108,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248763,6 +306429,83 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -248874,7 +306617,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248917,7 +306660,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248938,6 +306681,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseEducationOrganizationTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseEducationOrganizationTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -248973,7 +306836,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249005,15 +306868,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -249040,7 +306894,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249097,7 +306951,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249406,6 +307260,83 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "staffUniqueId", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -249517,7 +307448,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249560,7 +307491,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249581,6 +307512,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponseStaffTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseStaffTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponseStaffTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseStaffTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponseStaffTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -249616,7 +307667,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249648,15 +307699,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -249683,7 +307725,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249740,7 +307782,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250074,6 +308116,78 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponse_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -250184,7 +308298,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250227,7 +308341,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250248,6 +308362,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -250283,7 +308517,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250315,15 +308549,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -250350,7 +308575,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250407,7 +308632,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250648,6 +308873,73 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySection_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySection_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySection_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -250739,7 +309031,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250782,7 +309074,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250803,6 +309095,126 @@ "Survey" ] }, + "/ed-fi/surveySections/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySections" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySections/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySections" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySections/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -250838,7 +309250,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250870,15 +309282,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -250905,7 +309308,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250962,7 +309365,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -251349,6 +309752,68 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_Survey_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Survey_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_Survey_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -251496,7 +309961,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251539,7 +310004,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -251560,6 +310025,126 @@ "Survey" ] }, + "/ed-fi/surveys/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveysDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveys" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveys/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveysKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveys" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveys/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -251595,7 +310180,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -251627,15 +310212,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -251662,7 +310238,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251719,7 +310295,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -251963,6 +310539,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TeachingCredentialBasisDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -252079,7 +310716,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252122,7 +310759,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252142,6 +310779,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/teachingCredentialBasisDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialBasesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "teachingCredentialBasisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/teachingCredentialBasisDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialBasesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "teachingCredentialBasisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/teachingCredentialBasisDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -252177,7 +310932,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252209,15 +310964,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -252244,7 +310990,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252301,7 +311047,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252526,6 +311272,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TeachingCredentialDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TeachingCredentialDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TeachingCredentialDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -252642,7 +311449,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252685,7 +311492,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252705,6 +311512,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/teachingCredentialDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "teachingCredentialDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/teachingCredentialDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "teachingCredentialDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/teachingCredentialDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -252740,7 +311665,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252772,15 +311697,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -252807,7 +311723,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252864,7 +311780,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -253089,6 +312005,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -253205,7 +312182,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253248,7 +312225,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -253268,6 +312245,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/technicalSkillsAssessmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTechnicalSkillsAssessmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "technicalSkillsAssessmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/technicalSkillsAssessmentDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTechnicalSkillsAssessmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "technicalSkillsAssessmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/technicalSkillsAssessmentDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -253303,7 +312398,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -253335,15 +312430,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -253370,7 +312456,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253427,7 +312513,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -253652,6 +312738,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TelephoneNumberTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -253768,7 +312915,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253811,7 +312958,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -253831,6 +312978,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/telephoneNumberTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTelephoneNumberTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "telephoneNumberTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/telephoneNumberTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTelephoneNumberTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "telephoneNumberTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/telephoneNumberTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -253866,7 +313131,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -253898,15 +313163,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -253933,7 +313189,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253990,7 +313246,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -254215,6 +313471,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TermDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TermDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TermDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -254331,7 +313648,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254374,7 +313691,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -254394,6 +313711,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/termDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTermsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "termDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/termDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTermsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "termDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/termDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -254429,7 +313864,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -254461,15 +313896,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -254496,7 +313922,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254553,7 +313979,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -254778,6 +314204,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TitleIPartAParticipantDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -254894,7 +314381,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254937,7 +314424,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -254957,6 +314444,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/titleIPartAParticipantDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAParticipantsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "titleIPartAParticipantDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/titleIPartAParticipantDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAParticipantsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "titleIPartAParticipantDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/titleIPartAParticipantDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -254992,7 +314597,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -255024,15 +314629,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -255059,7 +314655,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255116,7 +314712,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -255341,6 +314937,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -255457,7 +315114,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255500,7 +315157,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -255520,6 +315177,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/titleIPartAProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "titleIPartAProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/titleIPartAProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "titleIPartAProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/titleIPartAProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -255555,7 +315330,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -255587,15 +315362,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -255622,7 +315388,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255679,7 +315445,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -255904,6 +315670,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -256020,7 +315847,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256063,7 +315890,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -256083,6 +315910,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/titleIPartASchoolDesignationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartASchoolDesignationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "titleIPartASchoolDesignationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/titleIPartASchoolDesignationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartASchoolDesignationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "titleIPartASchoolDesignationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/titleIPartASchoolDesignationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -256118,7 +316063,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -256150,15 +316095,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -256185,7 +316121,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256242,7 +316178,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -256467,6 +316403,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -256583,7 +316580,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256626,7 +316623,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -256646,6 +316643,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/transportationPublicExpenseEligibilityTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTransportationPublicExpenseEligibilityTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "transportationPublicExpenseEligibilityTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/transportationPublicExpenseEligibilityTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTransportationPublicExpenseEligibilityTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "transportationPublicExpenseEligibilityTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/transportationPublicExpenseEligibilityTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -256681,7 +316796,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -256713,15 +316828,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -256748,7 +316854,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256805,7 +316911,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257030,6 +317136,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TransportationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TransportationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TransportationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -257146,7 +317313,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257189,7 +317356,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257209,6 +317376,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/transportationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTransportationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "transportationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/transportationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTransportationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "transportationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/transportationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -257244,7 +317529,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257276,15 +317561,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -257311,7 +317587,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257368,7 +317644,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257593,6 +317869,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TravelDayofWeekDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TravelDayofWeekDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TravelDayofWeekDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -257709,7 +318046,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257752,7 +318089,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257772,6 +318109,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/travelDayofWeekDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTravelDayofWeeksDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "travelDayofWeekDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/travelDayofWeekDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTravelDayofWeeksKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "travelDayofWeekDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/travelDayofWeekDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -257807,7 +318262,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257839,15 +318294,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -257874,7 +318320,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257931,7 +318377,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -258156,6 +318602,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TravelDirectionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TravelDirectionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TravelDirectionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -258272,7 +318779,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258315,7 +318822,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -258335,6 +318842,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/travelDirectionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTravelDirectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "travelDirectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/travelDirectionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTravelDirectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "travelDirectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/travelDirectionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -258370,7 +318995,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -258402,15 +319027,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -258437,7 +319053,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258494,7 +319110,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -258719,6 +319335,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TribalAffiliationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TribalAffiliationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TribalAffiliationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -258835,7 +319512,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258878,7 +319555,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -258898,6 +319575,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/tribalAffiliationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTribalAffiliationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "tribalAffiliationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/tribalAffiliationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTribalAffiliationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "tribalAffiliationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/tribalAffiliationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -258933,7 +319728,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -258965,15 +319760,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -259000,7 +319786,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -259057,7 +319843,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -259282,6 +320068,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_VisaDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_VisaDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_VisaDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -259398,7 +320245,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -259441,7 +320288,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -259461,6 +320308,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/visaDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getVisasDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "visaDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/visaDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getVisasKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "visaDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/visaDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -259496,7 +320461,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -259528,15 +320493,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -259563,7 +320519,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -259620,7 +320576,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -259845,6 +320801,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_WeaponDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_WeaponDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_WeaponDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -259961,7 +320978,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -260004,7 +321021,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -260024,6 +321041,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/weaponDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getWeaponsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "weaponDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/weaponDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getWeaponsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "weaponDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/weaponDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -260059,7 +321194,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -260091,15 +321226,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -260126,7 +321252,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -260183,7 +321309,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" diff --git a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.0-api-schema-authoritative.json b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.0-api-schema-authoritative.json index 7a18d1550..2344a363e 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.0-api-schema-authoritative.json +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.0-api-schema-authoritative.json @@ -1061,6 +1061,66 @@ ], "isExtensionProject": false, "openApiBaseDocuments": { + "changeQueries": { + "components": { + "parameters": { + }, + "responses": { + }, + "schemas": { + } + }, + "info": { + "contact": { + "url": "https://www.ed-fi.org/what-is-ed-fi/contact/" + }, + "description": "The Ed-Fi DMS API enables applications to read and write education data stored in an Ed-Fi DMS through a secure REST interface. \n***\n > *Note: Consumers of DMS information should sanitize all data for display and storage. DMS provides reasonable safeguards against cross-site scripting attacks and other malicious content, but the platform does not and cannot guarantee that the data it contains is free of all potentially harmful content.* \n***\n", + "title": "Ed-Fi Data Management Service API", + "version": "1" + }, + "openapi": "3.0.0", + "paths": { + "/availableChangeVersions": { + "get": { + "operationId": "getAvailableChangeVersions", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "newestChangeVersion": { + "format": "int64", + "type": "integer" + }, + "oldestChangeVersion": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "oldestChangeVersion", + "newestChangeVersion" + ], + "type": "object" + } + } + }, + "description": "The available change version range was successfully retrieved." + } + }, + "summary": "Retrieves the available change version range." + } + } + }, + "servers": [ + { + "url": "" + } + ], + "tags": [ + ] + }, "descriptors": { "components": { "parameters": { @@ -1086,6 +1146,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1095,6 +1156,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1209,9 +1271,6 @@ "NotFound": { "description": "The resource could not be found." }, - "NotFoundUseSnapshot": { - "description": "The resource could not be found. If Use-Snapshot header is set to true, this response can indicate the snapshot may have been removed." - }, "NotModified": { "description": "The resource's current server-side ETag value matched the If-None-Match header value supplied with the request indicating the resource has not been modified." }, @@ -1272,6 +1331,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1281,6 +1341,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1395,9 +1456,6 @@ "NotFound": { "description": "The resource could not be found." }, - "NotFoundUseSnapshot": { - "description": "The resource could not be found. If Use-Snapshot header is set to true, this response can indicate the snapshot may have been removed." - }, "NotModified": { "description": "The resource's current server-side ETag value matched the If-None-Match header value supplied with the request indicating the resource has not been modified." }, @@ -2049,6 +2107,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AbsenceEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -2165,7 +2284,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2208,7 +2327,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2229,6 +2348,126 @@ "Staff" ] }, + "/ed-fi/absenceEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAbsenceEventCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "absenceEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/absenceEventCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAbsenceEventCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "absenceEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/absenceEventCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -2264,7 +2503,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2296,15 +2535,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -2331,7 +2561,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2388,7 +2618,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2619,6 +2849,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AcademicHonorCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -2735,7 +3026,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2778,7 +3069,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2803,27 +3094,40 @@ "StudentTranscript" ] }, - "/ed-fi/academicHonorCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAcademicHonorCategoriesById", + "/ed-fi/academicHonorCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicHonorCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2837,48 +3141,42 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "academicHonorCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/academicHonorCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAcademicHonorCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicHonorCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -2886,14 +3184,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2905,20 +3203,29 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "academicHonorCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAcademicHonorCategory", + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/academicHonorCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAcademicHonorCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -2933,18 +3240,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AcademicHonorCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AcademicHonorCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -2962,7 +3257,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "academicHonorCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAcademicHonorCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "academicHonorCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAcademicHonorCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AcademicHonorCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AcademicHonorCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3218,6 +3628,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AcademicSubjectDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AcademicSubjectDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AcademicSubjectDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3334,7 +3805,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3377,7 +3848,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3423,82 +3894,25 @@ "StudentTranscript" ] }, - "/ed-fi/academicSubjectDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAcademicSubjectsById", + "/ed-fi/academicSubjectDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicSubjectsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Updated" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "404": { - "$ref": "#/components/responses/NotFound" - }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "$ref": "#/components/parameters/MaxChangeVersion" }, - "500": { - "$ref": "#/components/responses/Error" - } - }, - "summary": "Deletes an existing resource using the resource identifier.", - "tags": [ - "academicSubjectDescriptors" - ] - }, - "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAcademicSubjectsById", - "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/limit" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/offset" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -3506,68 +3920,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeDelete" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" - }, - "500": { - "$ref": "#/components/responses/Error" - } - }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", - "tags": [ - "academicSubjectDescriptors" - ] - }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAcademicSubject", - "parameters": [ - { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/If-Match" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" - } - } - }, - "description": "The JSON representation of the AcademicSubject resource to be created or updated.", - "required": true, - "x-bodyName": "AcademicSubject" - }, - "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3581,20 +3941,292 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Updates a resource based on the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "academicSubjectDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Credential", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "PerformanceEvaluation", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "Standards", + "StudentTranscript" + ] + }, + "/ed-fi/academicSubjectDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicSubjectsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "academicSubjectDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Credential", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "PerformanceEvaluation", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "Standards", + "StudentTranscript" + ] + }, + "/ed-fi/academicSubjectDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAcademicSubjectsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "academicSubjectDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAcademicSubjectsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "academicSubjectDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAcademicSubject", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" + } + } + }, + "description": "The JSON representation of the AcademicSubject resource to be created or updated.", + "required": true, + "x-bodyName": "AcademicSubject" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Updates a resource based on the resource identifier.", "tags": [ "academicSubjectDescriptors" ] @@ -3896,6 +4528,68 @@ "weekIdentifier" ], "type": "object" + }, + "EdFi_AcademicWeek_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AcademicWeek_TrackedChangeKey": { + "properties": { + "schoolId": { + "format": "int64", + "type": "integer" + }, + "weekIdentifier": { + "maxLength": 80, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "schoolId", + "weekIdentifier" + ], + "type": "object" + }, + "EdFi_AcademicWeek_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -4004,7 +4698,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4047,7 +4741,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4068,6 +4762,126 @@ "SchoolCalendar" ] }, + "/ed-fi/academicWeeks/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicWeeksDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "academicWeeks" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/academicWeeks/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicWeeksKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "academicWeeks" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, "/ed-fi/academicWeeks/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -4103,7 +4917,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4135,15 +4949,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -4170,7 +4975,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4227,7 +5032,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4453,6 +5258,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AccommodationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccommodationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AccommodationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -4569,7 +5435,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4612,7 +5478,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4635,6 +5501,130 @@ "StudentAssessment" ] }, + "/ed-fi/accommodationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccommodationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "accommodationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentRegistration", + "StudentAssessment" + ] + }, + "/ed-fi/accommodationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccommodationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "accommodationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentRegistration", + "StudentAssessment" + ] + }, "/ed-fi/accommodationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -4670,7 +5660,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4702,15 +5692,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -4737,7 +5718,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4794,7 +5775,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5023,6 +6004,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AccountTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccountTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AccountTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -5139,7 +6181,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5182,7 +6224,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5203,6 +6245,126 @@ "Finance" ] }, + "/ed-fi/accountTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccountTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "accountTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/accountTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccountTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "accountTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/accountTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -5238,7 +6400,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5270,15 +6432,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -5305,7 +6458,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5362,7 +6515,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5709,6 +6862,72 @@ "schoolYear" ], "type": "object" + }, + "EdFi_AccountabilityRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccountabilityRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "ratingTitle": { + "maxLength": 60, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "educationOrganizationId", + "ratingTitle", + "schoolYear" + ], + "type": "object" + }, + "EdFi_AccountabilityRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -5835,7 +7054,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5878,7 +7097,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5900,6 +7119,128 @@ "Enrollment" ] }, + "/ed-fi/accountabilityRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccountabilityRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "accountabilityRatings" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment" + ] + }, + "/ed-fi/accountabilityRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccountabilityRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "accountabilityRatings" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment" + ] + }, "/ed-fi/accountabilityRatings/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -5935,7 +7276,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5967,15 +7308,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -6002,7 +7334,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6059,7 +7391,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6310,6 +7642,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AccreditationStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccreditationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccreditationStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AccreditationStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccreditationStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccreditationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -6426,7 +7819,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6469,7 +7862,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6504,6 +7897,154 @@ "SectionsAndPrograms" ] }, + "/ed-fi/accreditationStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccreditationStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccreditationStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "accreditationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/accreditationStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccreditationStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccreditationStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "accreditationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/accreditationStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -6539,7 +8080,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6571,15 +8112,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -6606,7 +8138,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6663,7 +8195,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6903,6 +8435,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AchievementCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AchievementCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AchievementCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -7019,7 +8612,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7062,7 +8655,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7082,6 +8675,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/achievementCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAchievementCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "achievementCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/achievementCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAchievementCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "achievementCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/achievementCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -7117,7 +8828,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7149,15 +8860,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -7184,7 +8886,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7241,7 +8943,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7470,6 +9172,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AdditionalCreditTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -7586,7 +9349,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7629,7 +9392,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7653,6 +9416,132 @@ "StudentTranscript" ] }, + "/ed-fi/additionalCreditTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAdditionalCreditTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "additionalCreditTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/additionalCreditTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAdditionalCreditTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "additionalCreditTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/additionalCreditTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -7688,7 +9577,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7720,15 +9609,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -7755,7 +9635,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7812,7 +9692,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8065,6 +9945,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AddressTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AddressTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AddressTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -8181,7 +10122,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8224,7 +10165,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8268,6 +10209,172 @@ "StudentTranscript" ] }, + "/ed-fi/addressTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAddressTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "addressTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/addressTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAddressTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "addressTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/addressTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -8303,7 +10410,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8335,15 +10442,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -8370,7 +10468,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8427,7 +10525,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8678,6 +10776,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AdministrationEnvironmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -8794,7 +10953,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8837,7 +10996,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8859,6 +11018,128 @@ "StudentAssessment" ] }, + "/ed-fi/administrationEnvironmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrationEnvironmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "administrationEnvironmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/administrationEnvironmentDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrationEnvironmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "administrationEnvironmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, "/ed-fi/administrationEnvironmentDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -8894,7 +11175,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8926,15 +11207,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -8961,7 +11233,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9018,7 +11290,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9259,6 +11531,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AdministrativeFundingControlDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -9375,7 +11708,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9418,7 +11751,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9452,6 +11785,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/administrativeFundingControlDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrativeFundingControlsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "administrativeFundingControlDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/administrativeFundingControlDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrativeFundingControlsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "administrativeFundingControlDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/administrativeFundingControlDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -9487,7 +11966,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9519,15 +11998,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -9554,7 +12024,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9611,7 +12081,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9851,6 +12321,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AidTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AidTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AidTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AidTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AidTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AidTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -9967,7 +12498,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10010,7 +12541,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10031,6 +12562,126 @@ "Enrollment" ] }, + "/ed-fi/aidTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAidTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AidTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "aidTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/aidTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAidTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AidTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "aidTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/aidTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -10066,7 +12717,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10098,15 +12749,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -10133,7 +12775,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10190,7 +12832,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10429,6 +13071,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AncestryEthnicOriginDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -10545,7 +13248,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10588,7 +13291,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10621,6 +13324,150 @@ "SectionsAndPrograms" ] }, + "/ed-fi/ancestryEthnicOriginDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAncestryEthnicOriginsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "ancestryEthnicOriginDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Enrollment", + "Finance", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/ancestryEthnicOriginDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAncestryEthnicOriginsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "ancestryEthnicOriginDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Enrollment", + "Finance", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/ancestryEthnicOriginDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -10656,7 +13503,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10688,15 +13535,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -10723,7 +13561,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10780,7 +13618,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -13391,6 +16229,63 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "EdFi_ApplicantProfile_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ApplicantProfile_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ApplicantProfile_TrackedChangeKey": { + "properties": { + "applicantProfileIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "applicantProfileIdentifier" + ], + "type": "object" + }, + "EdFi_ApplicantProfile_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicantProfile_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicantProfile_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -13630,7 +16525,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -13673,7 +16568,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -13694,6 +16589,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/applicantProfiles/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getApplicantProfilesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicantProfile_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "applicantProfiles" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/applicantProfiles/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getApplicantProfilesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicantProfile_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "applicantProfiles" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/applicantProfiles/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -13729,7 +16744,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -13761,15 +16776,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -13796,7 +16802,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -13853,7 +16859,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14171,6 +17177,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ApplicationEventResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEventResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ApplicationEventResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ApplicationEventResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEventResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEventResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -14287,7 +17354,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14330,7 +17397,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14351,6 +17418,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/applicationEventResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationEventResultsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationEventResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "applicationEventResultDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/applicationEventResultDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationEventResultsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationEventResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "applicationEventResultDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/applicationEventResultDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -14386,7 +17573,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14418,15 +17605,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -14453,7 +17631,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14510,7 +17688,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14737,6 +17915,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ApplicationEventTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ApplicationEventTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ApplicationEventTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEventTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -14853,7 +18092,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14896,7 +18135,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14917,6 +18156,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/applicationEventTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationEventTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationEventTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "applicationEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/applicationEventTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationEventTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationEventTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "applicationEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/applicationEventTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -14952,7 +18311,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14984,15 +18343,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -15019,7 +18369,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15076,7 +18426,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15527,6 +18877,89 @@ "sequenceNumber" ], "type": "object" + }, + "EdFi_ApplicationEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ApplicationEvent_TrackedChangeKey": { + "properties": { + "applicantProfileIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "applicationEventTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "applicationIdentifier": { + "maxLength": 20, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "sequenceNumber": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "applicantProfileIdentifier", + "applicationEventTypeDescriptor", + "applicationIdentifier", + "educationOrganizationId", + "eventDate", + "sequenceNumber" + ], + "type": "object" + }, + "EdFi_ApplicationEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -15694,7 +19127,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15737,7 +19170,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15758,6 +19191,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/applicationEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "applicationEvents" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/applicationEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "applicationEvents" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/applicationEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -15793,7 +19346,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15825,15 +19378,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -15860,7 +19404,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15917,7 +19461,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16177,6 +19721,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ApplicationSourceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationSourceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ApplicationSourceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ApplicationSourceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationSourceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationSourceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -16293,7 +19898,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16336,7 +19941,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16357,6 +19962,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/applicationSourceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationSourcesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationSourceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "applicationSourceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/applicationSourceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationSourcesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationSourceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "applicationSourceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/applicationSourceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -16392,7 +20117,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16424,15 +20149,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -16459,7 +20175,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16516,7 +20232,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16743,6 +20459,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ApplicationStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ApplicationStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ApplicationStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -16859,7 +20636,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16902,7 +20679,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16923,6 +20700,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/applicationStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "applicationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/applicationStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "applicationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/applicationStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -16958,7 +20855,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16990,15 +20887,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -17025,7 +20913,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17082,7 +20970,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17903,6 +21791,74 @@ "termDescriptor" ], "type": "object" + }, + "EdFi_Application_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Application_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Application_TrackedChangeKey": { + "properties": { + "applicantProfileIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "applicationIdentifier": { + "maxLength": 20, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "applicantProfileIdentifier", + "applicationIdentifier", + "educationOrganizationId" + ], + "type": "object" + }, + "EdFi_Application_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Application_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Application_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -18112,7 +22068,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18155,7 +22111,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18176,6 +22132,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/applications/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Application_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "applications" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/applications/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Application_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "applications" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/applications/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -18211,7 +22287,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18243,15 +22319,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -18278,7 +22345,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18335,7 +22402,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18848,6 +22915,83 @@ "participatingEducationOrganizationId" ], "type": "object" + }, + "EdFi_AssessmentAdministrationParticipation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentAdministrationParticipation_TrackedChangeKey": { + "properties": { + "administrationIdentifier": { + "maxLength": 255, + "type": "string" + }, + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "assigningEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "participatingEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "administrationIdentifier", + "assessmentIdentifier", + "assigningEducationOrganizationId", + "namespace", + "participatingEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_AssessmentAdministrationParticipation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -18959,7 +23103,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19002,7 +23146,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19023,6 +23167,126 @@ "AssessmentRegistration" ] }, + "/ed-fi/assessmentAdministrationParticipations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentAdministrationParticipationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentAdministrationParticipations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/assessmentAdministrationParticipations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentAdministrationParticipationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentAdministrationParticipations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, "/ed-fi/assessmentAdministrationParticipations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -19058,7 +23322,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19090,15 +23354,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -19125,7 +23380,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19182,7 +23437,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19639,6 +23894,78 @@ "assigningEducationOrganizationId" ], "type": "object" + }, + "EdFi_AssessmentAdministration_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentAdministration_TrackedChangeKey": { + "properties": { + "administrationIdentifier": { + "maxLength": 255, + "type": "string" + }, + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "assigningEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "administrationIdentifier", + "assessmentIdentifier", + "assigningEducationOrganizationId", + "namespace" + ], + "type": "object" + }, + "EdFi_AssessmentAdministration_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -19740,7 +24067,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19783,7 +24110,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19804,6 +24131,126 @@ "AssessmentRegistration" ] }, + "/ed-fi/assessmentAdministrations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentAdministrationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentAdministrations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/assessmentAdministrations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentAdministrationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentAdministrations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, "/ed-fi/assessmentAdministrations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -19839,7 +24286,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19871,15 +24318,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -19906,7 +24344,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19963,7 +24401,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20302,6 +24740,73 @@ "assessmentBatteryPartName" ], "type": "object" + }, + "EdFi_AssessmentBatteryPart_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentBatteryPart_TrackedChangeKey": { + "properties": { + "assessmentBatteryPartName": { + "maxLength": 65, + "type": "string" + }, + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentBatteryPartName", + "assessmentIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_AssessmentBatteryPart_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -20393,7 +24898,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20436,7 +24941,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20457,6 +24962,126 @@ "AssessmentRegistration" ] }, + "/ed-fi/assessmentBatteryParts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentBatteryPartsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentBatteryParts" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/assessmentBatteryParts/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentBatteryPartsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentBatteryParts" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, "/ed-fi/assessmentBatteryParts/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -20492,7 +25117,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20524,15 +25149,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -20559,7 +25175,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20616,7 +25232,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20827,6 +25443,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -20943,7 +25620,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20986,7 +25663,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21008,6 +25685,128 @@ "AssessmentMetadata" ] }, + "/ed-fi/assessmentCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessmentCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, "/ed-fi/assessmentCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -21043,7 +25842,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21075,15 +25874,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -21110,7 +25900,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21167,7 +25957,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21396,6 +26186,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -21512,7 +26363,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21555,7 +26406,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21577,6 +26428,128 @@ "AssessmentMetadata" ] }, + "/ed-fi/assessmentIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentIdentificationSystemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessmentIdentificationSystemDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentIdentificationSystemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, "/ed-fi/assessmentIdentificationSystemDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -21612,7 +26585,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21644,15 +26617,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -21679,7 +26643,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21736,7 +26700,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21965,6 +26929,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentItemCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -22081,7 +27106,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22124,7 +27149,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22146,6 +27171,128 @@ "AssessmentMetadata" ] }, + "/ed-fi/assessmentItemCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentItemCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessmentItemCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentItemCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, "/ed-fi/assessmentItemCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -22181,7 +27328,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22213,15 +27360,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -22248,7 +27386,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22305,7 +27443,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22534,6 +27672,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentItemResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentItemResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentItemResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -22650,7 +27849,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22693,7 +27892,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22715,6 +27914,128 @@ "StudentAssessment" ] }, + "/ed-fi/assessmentItemResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemResultsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentItemResultDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/assessmentItemResultDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemResultsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentItemResultDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, "/ed-fi/assessmentItemResultDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -22750,7 +28071,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22782,15 +28103,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -22817,7 +28129,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22874,7 +28186,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23391,6 +28703,73 @@ "identificationCode" ], "type": "object" + }, + "EdFi_AssessmentItem_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentItem_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "identificationCode": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "identificationCode", + "namespace" + ], + "type": "object" + }, + "EdFi_AssessmentItem_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -23537,7 +28916,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23580,7 +28959,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23602,6 +28981,128 @@ "AssessmentMetadata" ] }, + "/ed-fi/assessmentItems/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentItems" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessmentItems/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentItems" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, "/ed-fi/assessmentItems/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -23637,7 +29138,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23669,15 +29170,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -23704,7 +29196,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23761,7 +29253,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24009,6 +29501,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -24125,7 +29678,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24168,7 +29721,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24191,6 +29744,130 @@ "StudentAssessment" ] }, + "/ed-fi/assessmentPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentPeriodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata", + "StudentAssessment" + ] + }, + "/ed-fi/assessmentPeriodDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentPeriodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata", + "StudentAssessment" + ] + }, "/ed-fi/assessmentPeriodDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -24226,7 +29903,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24258,15 +29935,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -24293,7 +29961,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24350,7 +30018,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24582,6 +30250,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentReportingMethodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -24698,7 +30427,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24741,7 +30470,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24765,6 +30494,132 @@ "StudentAssessment" ] }, + "/ed-fi/assessmentReportingMethodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentReportingMethodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentReportingMethodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "RecruitingAndStaffing", + "AssessmentMetadata", + "StudentAssessment" + ] + }, + "/ed-fi/assessmentReportingMethodDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentReportingMethodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentReportingMethodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "RecruitingAndStaffing", + "AssessmentMetadata", + "StudentAssessment" + ] + }, "/ed-fi/assessmentReportingMethodDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -24800,7 +30655,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24832,15 +30687,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -24867,7 +30713,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24924,7 +30770,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25366,6 +31212,73 @@ "scoreRangeId" ], "type": "object" + }, + "EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "scoreRangeId": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "namespace", + "scoreRangeId" + ], + "type": "object" + }, + "EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -25494,7 +31407,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25537,7 +31450,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25558,6 +31471,126 @@ "Assessment" ] }, + "/ed-fi/assessmentScoreRangeLearningStandards/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentScoreRangeLearningStandardsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentScoreRangeLearningStandards" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, + "/ed-fi/assessmentScoreRangeLearningStandards/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentScoreRangeLearningStandardsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentScoreRangeLearningStandards" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, "/ed-fi/assessmentScoreRangeLearningStandards/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -25593,7 +31626,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25625,15 +31658,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -25660,7 +31684,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25717,7 +31741,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27224,6 +33248,68 @@ "sectionReference" ], "type": "object" + }, + "EdFi_Assessment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Assessment_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_Assessment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -27404,7 +33490,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27447,7 +33533,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27469,6 +33555,128 @@ "AssessmentMetadata" ] }, + "/ed-fi/assessments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessments" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessments/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessments" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, "/ed-fi/assessments/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -27504,7 +33712,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27536,15 +33744,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -27571,7 +33770,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27628,7 +33827,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27908,6 +34107,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssignmentLateStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssignmentLateStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -28024,7 +34284,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28067,7 +34327,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28089,6 +34349,128 @@ "Gradebook" ] }, + "/ed-fi/assignmentLateStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssignmentLateStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assignmentLateStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/assignmentLateStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssignmentLateStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assignmentLateStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, "/ed-fi/assignmentLateStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -28124,7 +34506,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28156,15 +34538,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -28191,7 +34564,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28248,7 +34621,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28484,6 +34857,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AttemptStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AttemptStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AttemptStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -28600,7 +35034,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28643,7 +35077,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28672,6 +35106,142 @@ "SectionsAndPrograms" ] }, + "/ed-fi/attemptStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAttemptStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "attemptStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/attemptStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAttemptStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "attemptStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/attemptStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -28707,7 +35277,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28739,15 +35309,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -28774,7 +35335,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28831,7 +35392,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29069,6 +35630,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AttendanceEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -29185,7 +35807,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29228,7 +35850,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29252,6 +35874,132 @@ "StudentAttendance" ] }, + "/ed-fi/attendanceEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAttendanceEventCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "attendanceEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Intervention", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/attendanceEventCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAttendanceEventCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "attendanceEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Intervention", + "SpecialEducation", + "StudentAttendance" + ] + }, "/ed-fi/attendanceEventCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -29287,7 +36035,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29319,15 +36067,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -29354,7 +36093,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29411,7 +36150,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29643,6 +36382,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BackgroundCheckStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BackgroundCheckStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BackgroundCheckStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -29759,7 +36559,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29802,7 +36602,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29825,6 +36625,130 @@ "Staff" ] }, + "/ed-fi/backgroundCheckStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBackgroundCheckStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "backgroundCheckStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "RecruitingAndStaffing", + "Staff" + ] + }, + "/ed-fi/backgroundCheckStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBackgroundCheckStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "backgroundCheckStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "RecruitingAndStaffing", + "Staff" + ] + }, "/ed-fi/backgroundCheckStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -29860,7 +36784,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29892,15 +36816,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -29927,7 +36842,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29984,7 +36899,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -30215,6 +37130,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BackgroundCheckTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BackgroundCheckTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BackgroundCheckTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -30331,7 +37307,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30374,7 +37350,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -30397,6 +37373,130 @@ "Staff" ] }, + "/ed-fi/backgroundCheckTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBackgroundCheckTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "backgroundCheckTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "RecruitingAndStaffing", + "Staff" + ] + }, + "/ed-fi/backgroundCheckTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBackgroundCheckTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "backgroundCheckTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "RecruitingAndStaffing", + "Staff" + ] + }, "/ed-fi/backgroundCheckTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -30432,7 +37532,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -30464,15 +37564,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -30499,7 +37590,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30556,7 +37647,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -30846,6 +37937,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_BalanceSheetDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BalanceSheetDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_BalanceSheetDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -30935,7 +38087,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30978,7 +38130,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -30999,6 +38151,126 @@ "Finance" ] }, + "/ed-fi/balanceSheetDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBalanceSheetDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "balanceSheetDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/balanceSheetDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBalanceSheetDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "balanceSheetDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/balanceSheetDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -31034,7 +38306,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31066,15 +38338,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -31101,7 +38364,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31158,7 +38421,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31367,6 +38630,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -31483,7 +38807,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31526,7 +38850,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31548,6 +38872,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/barrierToInternetAccessInResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBarrierToInternetAccessInResidencesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "barrierToInternetAccessInResidenceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/barrierToInternetAccessInResidenceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBarrierToInternetAccessInResidencesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "barrierToInternetAccessInResidenceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/barrierToInternetAccessInResidenceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -31583,7 +39029,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31615,15 +39061,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -31650,7 +39087,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31707,7 +39144,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31935,6 +39372,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BehaviorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BehaviorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BehaviorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -32051,7 +39549,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32094,7 +39592,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -32115,6 +39613,126 @@ "Discipline" ] }, + "/ed-fi/behaviorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBehaviorsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "behaviorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/behaviorDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBehaviorsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "behaviorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/behaviorDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -32150,7 +39768,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -32182,15 +39800,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -32217,7 +39826,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32274,7 +39883,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -32760,6 +40369,67 @@ "schoolId" ], "type": "object" + }, + "EdFi_BellSchedule_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BellSchedule_TrackedChangeKey": { + "properties": { + "bellScheduleName": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "bellScheduleName", + "schoolId" + ], + "type": "object" + }, + "EdFi_BellSchedule_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -32874,7 +40544,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32917,7 +40587,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -32938,6 +40608,126 @@ "BellSchedule" ] }, + "/ed-fi/bellSchedules/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBellSchedulesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "bellSchedules" + ] + }, + "x-Ed-Fi-domains": [ + "BellSchedule" + ] + }, + "/ed-fi/bellSchedules/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBellSchedulesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "bellSchedules" + ] + }, + "x-Ed-Fi-domains": [ + "BellSchedule" + ] + }, "/ed-fi/bellSchedules/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -32973,7 +40763,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -33005,15 +40795,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -33040,7 +40821,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -33097,7 +40878,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -33327,6 +41108,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BusRouteDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BusRouteDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BusRouteDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -33443,7 +41285,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -33486,7 +41328,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -33507,6 +41349,126 @@ "Enrollment" ] }, + "/ed-fi/busRouteDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBusRoutesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "busRouteDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/busRouteDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBusRoutesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "busRouteDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/busRouteDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -33542,7 +41504,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -33574,15 +41536,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -33609,7 +41562,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -33666,7 +41619,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -33990,6 +41943,77 @@ "date" ], "type": "object" + }, + "EdFi_CalendarDate_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CalendarDate_TrackedChangeKey": { + "properties": { + "calendarCode": { + "maxLength": 120, + "type": "string" + }, + "date": { + "format": "date", + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "calendarCode", + "date", + "schoolId", + "schoolYear" + ], + "type": "object" + }, + "EdFi_CalendarDate_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -34090,7 +42114,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34133,7 +42157,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34154,6 +42178,126 @@ "SchoolCalendar" ] }, + "/ed-fi/calendarDates/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarDatesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "calendarDates" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendarDates/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarDatesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "calendarDates" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, "/ed-fi/calendarDates/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -34189,7 +42333,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34221,15 +42365,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -34256,7 +42391,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34313,7 +42448,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34531,6 +42666,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CalendarEventDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CalendarEventDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CalendarEventDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -34647,7 +42843,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34690,7 +42886,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34711,6 +42907,126 @@ "SchoolCalendar" ] }, + "/ed-fi/calendarEventDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "calendarEventDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendarEventDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "calendarEventDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, "/ed-fi/calendarEventDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -34746,7 +43062,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34778,15 +43094,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -34813,7 +43120,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34870,7 +43177,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -35097,6 +43404,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CalendarTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CalendarTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CalendarTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -35213,7 +43581,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35256,7 +43624,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -35277,6 +43645,126 @@ "SchoolCalendar" ] }, + "/ed-fi/calendarTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "calendarTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendarTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "calendarTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, "/ed-fi/calendarTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -35312,7 +43800,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -35344,15 +43832,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -35379,7 +43858,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35436,7 +43915,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -35784,6 +44263,72 @@ "schoolYear" ], "type": "object" + }, + "EdFi_Calendar_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Calendar_TrackedChangeKey": { + "properties": { + "calendarCode": { + "maxLength": 120, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "calendarCode", + "schoolId", + "schoolYear" + ], + "type": "object" + }, + "EdFi_Calendar_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -35883,7 +44428,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35926,7 +44471,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -35947,6 +44492,126 @@ "SchoolCalendar" ] }, + "/ed-fi/calendars/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "calendars" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendars/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "calendars" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, "/ed-fi/calendars/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -35982,7 +44647,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -36014,15 +44679,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -36049,7 +44705,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36106,7 +44762,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -36324,6 +44980,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CandidateCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CandidateCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CandidateCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CandidateCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -36440,7 +45157,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36483,7 +45200,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -36504,6 +45221,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/candidateCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateCharacteristicsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "candidateCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/candidateCharacteristicDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateCharacteristicsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "candidateCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/candidateCharacteristicDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -36539,7 +45376,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -36571,15 +45408,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -36606,7 +45434,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36663,7 +45491,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -37476,6 +46304,84 @@ "programTypeDescriptor" ], "type": "object" + }, + "EdFi_CandidateEducatorPreparationProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CandidateEducatorPreparationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CandidateEducatorPreparationProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "candidateIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "beginDate", + "candidateIdentifier", + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_CandidateEducatorPreparationProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateEducatorPreparationProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateEducatorPreparationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -37637,7 +46543,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -37680,7 +46586,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -37701,6 +46607,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/candidateEducatorPreparationProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateEducatorPreparationProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateEducatorPreparationProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "candidateEducatorPreparationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/candidateEducatorPreparationProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateEducatorPreparationProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateEducatorPreparationProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "candidateEducatorPreparationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/candidateEducatorPreparationProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -37736,7 +46762,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -37768,15 +46794,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -37803,7 +46820,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -37860,7 +46877,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38197,6 +47214,73 @@ "educationOrganizationId" ], "type": "object" + }, + "EdFi_CandidateIdentificationCode_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CandidateIdentificationCode_TrackedChangeKey": { + "properties": { + "candidateIdentificationSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "candidateIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "candidateIdentificationSystemDescriptor", + "candidateIdentifier", + "educationOrganizationId" + ], + "type": "object" + }, + "EdFi_CandidateIdentificationCode_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationCode_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -38306,7 +47390,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38349,7 +47433,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38370,6 +47454,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/candidateIdentificationCodes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateIdentificationCodesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationCode_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "candidateIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/candidateIdentificationCodes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateIdentificationCodesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationCode_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "candidateIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/candidateIdentificationCodes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -38405,7 +47609,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38437,15 +47641,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -38472,7 +47667,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38529,7 +47724,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38753,6 +47948,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CandidateIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CandidateIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CandidateIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -38869,7 +48125,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38912,7 +48168,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38933,6 +48189,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/candidateIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateIdentificationSystemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "candidateIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/candidateIdentificationSystemDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateIdentificationSystemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "candidateIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/candidateIdentificationSystemDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -38968,7 +48344,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -39000,15 +48376,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -39035,7 +48402,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39092,7 +48459,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -39393,6 +48760,68 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_CandidateRelationshipToStaffAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CandidateRelationshipToStaffAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CandidateRelationshipToStaffAssociation_TrackedChangeKey": { + "properties": { + "candidateIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "candidateIdentifier", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_CandidateRelationshipToStaffAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateRelationshipToStaffAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateRelationshipToStaffAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -39501,7 +48930,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39544,7 +48973,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -39565,6 +48994,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/candidateRelationshipToStaffAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateRelationshipToStaffAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateRelationshipToStaffAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "candidateRelationshipToStaffAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/candidateRelationshipToStaffAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateRelationshipToStaffAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateRelationshipToStaffAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "candidateRelationshipToStaffAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/candidateRelationshipToStaffAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -39600,7 +49149,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -39632,15 +49181,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -39667,7 +49207,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39724,7 +49264,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -42716,6 +52256,63 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "EdFi_Candidate_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Candidate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Candidate_TrackedChangeKey": { + "properties": { + "candidateIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "candidateIdentifier" + ], + "type": "object" + }, + "EdFi_Candidate_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Candidate_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Candidate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -43067,7 +52664,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43110,7 +52707,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -43131,6 +52728,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/candidates/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCandidatesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Candidate_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "candidates" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/candidates/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCandidatesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Candidate_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "candidates" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/candidates/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -43166,7 +52883,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -43198,15 +52915,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -43233,7 +52941,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43290,7 +52998,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -43688,6 +53396,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CareerPathwayDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CareerPathwayDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CareerPathwayDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -43804,7 +53573,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43847,7 +53616,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -43874,6 +53643,138 @@ "StudentTranscript" ] }, + "/ed-fi/careerPathwayDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCareerPathwaysDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "careerPathwayDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/careerPathwayDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCareerPathwaysKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "careerPathwayDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/careerPathwayDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -43909,7 +53810,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -43941,15 +53842,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -43976,7 +53868,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44033,7 +53925,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44499,6 +54391,83 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "EdFi_CertificationExamResult_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamResult_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CertificationExamResult_TrackedChangeKey": { + "properties": { + "certificationExamDate": { + "format": "date", + "type": "string" + }, + "certificationExamIdentifier": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "certificationExamDate", + "certificationExamIdentifier", + "namespace", + "personId", + "sourceSystemDescriptor" + ], + "type": "object" + }, + "EdFi_CertificationExamResult_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamResult_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamResult_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -44686,7 +54655,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44729,7 +54698,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44750,6 +54719,126 @@ "Credential" ] }, + "/ed-fi/certificationExamResults/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationExamResultsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationExamResult_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certificationExamResults" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/certificationExamResults/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationExamResultsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationExamResult_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certificationExamResults" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/certificationExamResults/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -44785,7 +54874,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44817,15 +54906,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -44852,7 +54932,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44909,7 +54989,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -45184,6 +55264,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CertificationExamStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CertificationExamStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CertificationExamStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -45300,7 +55441,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -45343,7 +55484,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -45364,6 +55505,126 @@ "Credential" ] }, + "/ed-fi/certificationExamStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationExamStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationExamStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certificationExamStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/certificationExamStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationExamStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationExamStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certificationExamStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/certificationExamStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -45399,7 +55660,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -45431,15 +55692,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -45466,7 +55718,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -45523,7 +55775,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -45750,6 +56002,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CertificationExamTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CertificationExamTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CertificationExamTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -45866,7 +56179,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -45909,7 +56222,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -45930,6 +56243,126 @@ "Credential" ] }, + "/ed-fi/certificationExamTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationExamTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationExamTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certificationExamTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/certificationExamTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationExamTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationExamTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certificationExamTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/certificationExamTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -45965,7 +56398,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -45997,15 +56430,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -46032,7 +56456,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46089,7 +56513,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -46416,6 +56840,68 @@ "namespace" ], "type": "object" + }, + "EdFi_CertificationExam_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExam_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CertificationExam_TrackedChangeKey": { + "properties": { + "certificationExamIdentifier": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "certificationExamIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_CertificationExam_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExam_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExam_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -46544,7 +57030,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46587,7 +57073,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -46608,6 +57094,126 @@ "Credential" ] }, + "/ed-fi/certificationExams/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationExamsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationExam_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certificationExams" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/certificationExams/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationExamsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationExam_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certificationExams" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/certificationExams/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -46643,7 +57249,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -46675,15 +57281,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -46710,7 +57307,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46767,7 +57364,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -47000,6 +57597,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CertificationFieldDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CertificationFieldDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CertificationFieldDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CertificationFieldDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationFieldDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationFieldDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -47116,7 +57774,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47159,7 +57817,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -47180,6 +57838,126 @@ "Credential" ] }, + "/ed-fi/certificationFieldDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationFieldsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationFieldDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certificationFieldDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/certificationFieldDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationFieldsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationFieldDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certificationFieldDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/certificationFieldDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -47215,7 +57993,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -47247,15 +58025,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -47282,7 +58051,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47339,7 +58108,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -47566,6 +58335,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CertificationLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CertificationLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CertificationLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CertificationLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -47682,7 +58512,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47725,7 +58555,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -47746,6 +58576,126 @@ "Credential" ] }, + "/ed-fi/certificationLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certificationLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/certificationLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certificationLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/certificationLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -47781,7 +58731,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -47813,15 +58763,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -47848,7 +58789,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47905,7 +58846,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48135,6 +59076,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CertificationRouteDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CertificationRouteDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CertificationRouteDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CertificationRouteDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationRouteDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationRouteDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -48251,7 +59253,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -48294,7 +59296,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48318,6 +59320,132 @@ "Staff" ] }, + "/ed-fi/certificationRouteDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationRoutesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationRouteDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certificationRouteDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Enrollment", + "Graduation", + "Staff" + ] + }, + "/ed-fi/certificationRouteDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationRoutesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationRouteDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certificationRouteDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Enrollment", + "Graduation", + "Staff" + ] + }, "/ed-fi/certificationRouteDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -48353,7 +59481,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48385,15 +59513,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -48420,7 +59539,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -48477,7 +59596,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48707,6 +59826,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CertificationStandardDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CertificationStandardDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CertificationStandardDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CertificationStandardDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationStandardDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationStandardDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -48823,7 +60003,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -48866,7 +60046,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48887,6 +60067,126 @@ "Credential" ] }, + "/ed-fi/certificationStandardDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationStandardsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationStandardDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certificationStandardDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/certificationStandardDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationStandardsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationStandardDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certificationStandardDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/certificationStandardDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -48922,7 +60222,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48954,15 +60254,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -48989,7 +60280,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49046,7 +60337,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -49685,6 +60976,68 @@ "namespace" ], "type": "object" + }, + "EdFi_Certification_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Certification_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Certification_TrackedChangeKey": { + "properties": { + "certificationIdentifier": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "certificationIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_Certification_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Certification_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Certification_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -49867,7 +61220,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49910,7 +61263,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -49931,6 +61284,126 @@ "Credential" ] }, + "/ed-fi/certifications/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Certification_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certifications" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/certifications/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Certification_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certifications" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/certifications/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -49966,7 +61439,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -49998,15 +61471,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -50033,7 +61497,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -50090,7 +61554,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -50927,6 +62391,72 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ChartOfAccount_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ChartOfAccount_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ChartOfAccount_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -51115,7 +62645,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51158,7 +62688,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51179,6 +62709,126 @@ "Finance" ] }, + "/ed-fi/chartOfAccounts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getChartOfAccountsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "chartOfAccounts" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/chartOfAccounts/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getChartOfAccountsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "chartOfAccounts" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/chartOfAccounts/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -51214,7 +62864,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51246,15 +62896,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -51281,7 +62922,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51338,7 +62979,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51635,6 +63276,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -51751,7 +63453,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51794,7 +63496,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51828,6 +63530,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/charterApprovalAgencyTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCharterApprovalAgencyTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "charterApprovalAgencyTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/charterApprovalAgencyTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCharterApprovalAgencyTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "charterApprovalAgencyTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/charterApprovalAgencyTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -51863,7 +63711,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51895,15 +63743,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -51930,7 +63769,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51987,7 +63826,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52240,6 +64079,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CharterStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CharterStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CharterStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -52356,7 +64256,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52399,7 +64299,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52433,6 +64333,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/charterStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCharterStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "charterStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/charterStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCharterStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "charterStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/charterStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -52468,7 +64514,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52500,15 +64546,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -52535,7 +64572,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52592,7 +64629,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52855,6 +64892,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CitizenshipStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CitizenshipStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CitizenshipStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -52971,7 +65069,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53014,7 +65112,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53058,6 +65156,172 @@ "StudentTranscript" ] }, + "/ed-fi/citizenshipStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCitizenshipStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "citizenshipStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/citizenshipStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCitizenshipStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "citizenshipStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/citizenshipStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -53093,7 +65357,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53125,15 +65389,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -53160,7 +65415,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53217,7 +65472,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53555,6 +65810,67 @@ "schoolId" ], "type": "object" + }, + "EdFi_ClassPeriod_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ClassPeriod_TrackedChangeKey": { + "properties": { + "classPeriodName": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "classPeriodName", + "schoolId" + ], + "type": "object" + }, + "EdFi_ClassPeriod_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -53643,7 +65959,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53686,7 +66002,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53709,6 +66025,130 @@ "SectionsAndPrograms" ] }, + "/ed-fi/classPeriods/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getClassPeriodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "classPeriods" + ] + }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/classPeriods/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getClassPeriodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "classPeriods" + ] + }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/classPeriods/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -53744,7 +66184,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53776,15 +66216,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -53811,7 +66242,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53868,7 +66299,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54086,6 +66517,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ClassroomPositionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ClassroomPositionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ClassroomPositionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -54202,7 +66694,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54245,7 +66737,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54269,6 +66761,132 @@ "SectionsAndPrograms" ] }, + "/ed-fi/classroomPositionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getClassroomPositionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "classroomPositionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/classroomPositionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getClassroomPositionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "classroomPositionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/classroomPositionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -54304,7 +66922,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54336,15 +66954,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -54371,7 +66980,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54428,7 +67037,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54659,6 +67268,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CohortScopeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CohortScopeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CohortScopeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -54775,7 +67445,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54818,7 +67488,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54840,6 +67510,128 @@ "StudentCohort" ] }, + "/ed-fi/cohortScopeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortScopesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "cohortScopeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/cohortScopeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortScopesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "cohortScopeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/cohortScopeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -54875,7 +67667,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54907,15 +67699,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -54942,7 +67725,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54999,7 +67782,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55228,6 +68011,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CohortTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CohortTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CohortTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -55344,7 +68188,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55387,7 +68231,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55409,6 +68253,128 @@ "StudentCohort" ] }, + "/ed-fi/cohortTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "cohortTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/cohortTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "cohortTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/cohortTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -55444,7 +68410,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55476,15 +68442,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -55511,7 +68468,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55568,7 +68525,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55798,6 +68755,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CohortYearTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CohortYearTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CohortYearTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -55914,7 +68932,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55957,7 +68975,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55980,6 +68998,130 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/cohortYearTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortYearTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "cohortYearTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/cohortYearTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortYearTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "cohortYearTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/cohortYearTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -56015,7 +69157,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56047,15 +69189,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -56082,7 +69215,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56139,7 +69272,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56534,6 +69667,67 @@ "educationOrganizationId" ], "type": "object" + }, + "EdFi_Cohort_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Cohort_TrackedChangeKey": { + "properties": { + "cohortIdentifier": { + "maxLength": 36, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "cohortIdentifier", + "educationOrganizationId" + ], + "type": "object" + }, + "EdFi_Cohort_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -56650,7 +69844,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56693,7 +69887,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56715,6 +69909,128 @@ "StudentCohort" ] }, + "/ed-fi/cohorts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "cohorts" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/cohorts/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "cohorts" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/cohorts/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -56750,7 +70066,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56782,15 +70098,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -56817,7 +70124,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56874,7 +70181,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -57810,6 +71117,62 @@ ], "type": "object" }, + "EdFi_CommunityOrganization_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CommunityOrganization_TrackedChangeKey": { + "properties": { + "communityOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "communityOrganizationId" + ], + "type": "object" + }, + "EdFi_CommunityOrganization_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_EducationOrganization_Address": { "properties": { "addressTypeDescriptor": { @@ -58179,7 +71542,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -58222,7 +71585,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -58243,6 +71606,126 @@ "EducationOrganization" ] }, + "/ed-fi/communityOrganizations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityOrganizationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "communityOrganizations" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityOrganizations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityOrganizationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "communityOrganizations" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/communityOrganizations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -58278,7 +71761,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -58310,15 +71793,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -58345,7 +71819,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -58402,7 +71876,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -58820,6 +72294,72 @@ "licensingOrganization" ], "type": "object" + }, + "EdFi_CommunityProviderLicense_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CommunityProviderLicense_TrackedChangeKey": { + "properties": { + "communityProviderId": { + "format": "int64", + "type": "integer" + }, + "licenseIdentifier": { + "maxLength": 36, + "type": "string" + }, + "licensingOrganization": { + "maxLength": 75, + "type": "string" + } + }, + "required": [ + "communityProviderId", + "licenseIdentifier", + "licensingOrganization" + ], + "type": "object" + }, + "EdFi_CommunityProviderLicense_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -58982,7 +72522,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59025,7 +72565,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -59046,6 +72586,126 @@ "EducationOrganization" ] }, + "/ed-fi/communityProviderLicenses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProviderLicensesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "communityProviderLicenses" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityProviderLicenses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProviderLicensesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "communityProviderLicenses" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/communityProviderLicenses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -59081,7 +72741,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -59113,15 +72773,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -59148,7 +72799,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59205,7 +72856,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -60298,6 +73949,62 @@ ], "type": "object" }, + "EdFi_CommunityProvider_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CommunityProvider_TrackedChangeKey": { + "properties": { + "communityProviderId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "communityProviderId" + ], + "type": "object" + }, + "EdFi_CommunityProvider_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_EducationOrganization_Address": { "properties": { "addressTypeDescriptor": { @@ -60720,7 +74427,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -60763,7 +74470,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -60784,6 +74491,126 @@ "EducationOrganization" ] }, + "/ed-fi/communityProviders/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProvidersDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "communityProviders" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityProviders/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProvidersKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "communityProviders" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/communityProviders/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -60819,7 +74646,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -60851,15 +74678,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -60886,7 +74704,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -60943,7 +74761,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -61220,6 +75038,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CompetencyLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CompetencyLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CompetencyLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -61336,7 +75215,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -61379,7 +75258,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -61407,6 +75286,140 @@ "StudentTranscript" ] }, + "/ed-fi/competencyLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "competencyLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/competencyLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "competencyLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/competencyLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -61442,7 +75455,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -61474,15 +75487,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -61509,7 +75513,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -61566,7 +75570,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -61883,6 +75887,72 @@ "objectiveGradeLevelDescriptor" ], "type": "object" + }, + "EdFi_CompetencyObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CompetencyObjective_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "objective": { + "maxLength": 60, + "type": "string" + }, + "objectiveGradeLevelDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor" + ], + "type": "object" + }, + "EdFi_CompetencyObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -62000,7 +76070,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62043,7 +76113,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62065,6 +76135,128 @@ "ReportCard" ] }, + "/ed-fi/competencyObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyObjectivesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "competencyObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/competencyObjectives/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyObjectivesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "competencyObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, "/ed-fi/competencyObjectives/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -62100,7 +76292,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62132,15 +76324,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -62167,7 +76350,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62224,7 +76407,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62536,6 +76719,72 @@ "educationOrganizationId" ], "type": "object" + }, + "EdFi_ContactIdentificationCode_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContactIdentificationCode_TrackedChangeKey": { + "properties": { + "contactIdentificationSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "contactUniqueId": { + "maxLength": 32, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "contactIdentificationSystemDescriptor", + "contactUniqueId", + "educationOrganizationId" + ], + "type": "object" + }, + "EdFi_ContactIdentificationCode_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationCode_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -62644,7 +76893,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62687,7 +76936,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62708,6 +76957,126 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/contactIdentificationCodes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContactIdentificationCodesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationCode_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "contactIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/contactIdentificationCodes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContactIdentificationCodesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationCode_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "contactIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/contactIdentificationCodes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -62743,7 +77112,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62775,15 +77144,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -62810,7 +77170,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62867,7 +77227,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63092,6 +77452,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ContactIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContactIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ContactIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -63208,7 +77629,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63251,7 +77672,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63272,6 +77693,126 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/contactIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContactIdentificationSystemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "contactIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/contactIdentificationSystemDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContactIdentificationSystemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "contactIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/contactIdentificationSystemDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -63307,7 +77848,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63339,15 +77880,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -63374,7 +77906,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63431,7 +77963,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -65171,6 +79703,62 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "EdFi_Contact_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Contact_TrackedChangeKey": { + "properties": { + "contactUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "contactUniqueId" + ], + "type": "object" + }, + "EdFi_Contact_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -65369,7 +79957,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -65412,7 +80000,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -65434,6 +80022,128 @@ "Survey" ] }, + "/ed-fi/contacts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContactsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "contacts" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics", + "Survey" + ] + }, + "/ed-fi/contacts/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContactsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "contacts" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics", + "Survey" + ] + }, "/ed-fi/contacts/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -65469,7 +80179,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -65501,15 +80211,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -65536,7 +80237,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -65593,7 +80294,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -65882,6 +80583,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ContentClassDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContentClassDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ContentClassDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -65998,7 +80760,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66041,7 +80803,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66061,6 +80823,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/contentClassDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContentClassesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "contentClassDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/contentClassDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContentClassesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "contentClassDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/contentClassDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -66096,7 +80976,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66128,15 +81008,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -66163,7 +81034,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66220,7 +81091,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66446,6 +81317,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -66562,7 +81494,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66605,7 +81537,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66626,6 +81558,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/continuationOfServicesReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContinuationOfServicesReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "continuationOfServicesReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/continuationOfServicesReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContinuationOfServicesReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "continuationOfServicesReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/continuationOfServicesReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -66661,7 +81713,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66693,15 +81745,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -66728,7 +81771,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66785,7 +81828,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67012,6 +82055,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CostRateDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CostRateDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CostRateDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -67128,7 +82232,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67171,7 +82275,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67192,6 +82296,126 @@ "Intervention" ] }, + "/ed-fi/costRateDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCostRatesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "costRateDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/costRateDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCostRatesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "costRateDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, "/ed-fi/costRateDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -67227,7 +82451,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67259,15 +82483,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -67294,7 +82509,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67351,7 +82566,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67578,6 +82793,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CoteachingStyleObservedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CoteachingStyleObservedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CoteachingStyleObservedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CoteachingStyleObservedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CoteachingStyleObservedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CoteachingStyleObservedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -67694,7 +82970,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67737,7 +83013,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67758,6 +83034,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/coteachingStyleObservedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCoteachingStyleObservedsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CoteachingStyleObservedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "coteachingStyleObservedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/coteachingStyleObservedDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCoteachingStyleObservedsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CoteachingStyleObservedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "coteachingStyleObservedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/coteachingStyleObservedDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -67793,7 +83189,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67825,15 +83221,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -67860,7 +83247,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67917,7 +83304,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68170,6 +83557,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CountryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CountryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CountryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -68286,7 +83734,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68329,7 +83777,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68376,6 +83824,178 @@ "StudentTranscript" ] }, + "/ed-fi/countryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCountriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "countryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/countryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCountriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "countryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/countryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -68411,7 +84031,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68443,15 +84063,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -68478,7 +84089,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68535,7 +84146,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68791,6 +84402,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseAttemptResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseAttemptResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseAttemptResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -68907,7 +84579,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68950,7 +84622,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68974,6 +84646,132 @@ "StudentTranscript" ] }, + "/ed-fi/courseAttemptResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseAttemptResultsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courseAttemptResultDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courseAttemptResultDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseAttemptResultsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courseAttemptResultDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/courseAttemptResultDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -69009,7 +84807,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69041,15 +84839,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -69076,7 +84865,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69133,7 +84922,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69369,6 +85158,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseDefinedByDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseDefinedByDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseDefinedByDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -69485,7 +85335,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69528,7 +85378,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69555,6 +85405,138 @@ "StudentTranscript" ] }, + "/ed-fi/courseDefinedByDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseDefinedBiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courseDefinedByDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courseDefinedByDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseDefinedBiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courseDefinedByDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/courseDefinedByDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -69590,7 +85572,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69622,15 +85604,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -69657,7 +85630,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69714,7 +85687,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69953,6 +85926,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -70069,7 +86103,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70112,7 +86146,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70139,6 +86173,138 @@ "StudentTranscript" ] }, + "/ed-fi/courseGPAApplicabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseGPAApplicabilitiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courseGPAApplicabilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courseGPAApplicabilityDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseGPAApplicabilitiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courseGPAApplicabilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/courseGPAApplicabilityDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -70174,7 +86340,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70206,15 +86372,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -70241,7 +86398,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70298,7 +86455,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70537,6 +86694,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -70653,7 +86871,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70696,7 +86914,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70723,6 +86941,138 @@ "StudentTranscript" ] }, + "/ed-fi/courseIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseIdentificationSystemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courseIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courseIdentificationSystemDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseIdentificationSystemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courseIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/courseIdentificationSystemDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -70758,7 +87108,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70790,15 +87140,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -70825,7 +87166,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70882,7 +87223,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -71129,6 +87470,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -71245,7 +87647,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71288,7 +87690,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -71323,6 +87725,154 @@ "StudentTranscript" ] }, + "/ed-fi/courseLevelCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseLevelCharacteristicsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courseLevelCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courseLevelCharacteristicDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseLevelCharacteristicsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courseLevelCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/courseLevelCharacteristicDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -71358,7 +87908,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -71390,15 +87940,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -71425,7 +87966,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71482,7 +88023,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72058,6 +88599,77 @@ "sessionName" ], "type": "object" + }, + "EdFi_CourseOffering_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseOffering_TrackedChangeKey": { + "properties": { + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName" + ], + "type": "object" + }, + "EdFi_CourseOffering_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -72196,7 +88808,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72239,7 +88851,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72263,6 +88875,132 @@ "SectionsAndPrograms" ] }, + "/ed-fi/courseOfferings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseOfferingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courseOfferings" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/courseOfferings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseOfferingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courseOfferings" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/courseOfferings/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -72298,7 +89036,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72330,15 +89068,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -72365,7 +89094,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72422,7 +89151,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72674,6 +89403,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseRepeatCodeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseRepeatCodeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -72790,7 +89580,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72833,7 +89623,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72857,6 +89647,132 @@ "StudentTranscript" ] }, + "/ed-fi/courseRepeatCodeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseRepeatCodesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courseRepeatCodeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courseRepeatCodeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseRepeatCodesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courseRepeatCodeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/courseRepeatCodeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -72892,7 +89808,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72924,15 +89840,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -72959,7 +89866,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73016,7 +89923,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -74416,6 +91323,92 @@ "sectionReference" ], "type": "object" + }, + "EdFi_CourseTranscript_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseTranscript_TrackedChangeKey": { + "properties": { + "courseAttemptResultDescriptor": { + "maxLength": 306, + "type": "string" + }, + "courseCode": { + "maxLength": 120, + "type": "string" + }, + "courseEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "courseAttemptResultDescriptor", + "courseCode", + "courseEducationOrganizationId", + "educationOrganizationId", + "schoolYear", + "studentUniqueId", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_CourseTranscript_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -74711,7 +91704,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -74754,7 +91747,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -74778,6 +91771,132 @@ "StudentTranscript" ] }, + "/ed-fi/courseTranscripts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseTranscriptsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courseTranscripts" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courseTranscripts/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseTranscriptsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courseTranscripts" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/courseTranscripts/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -74813,7 +91932,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -74845,15 +91964,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -74880,7 +91990,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -74937,7 +92047,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76035,6 +93145,67 @@ "educationOrganizationId" ], "type": "object" + }, + "EdFi_Course_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Course_TrackedChangeKey": { + "properties": { + "courseCode": { + "maxLength": 120, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "courseCode", + "educationOrganizationId" + ], + "type": "object" + }, + "EdFi_Course_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -76258,7 +93429,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -76301,7 +93472,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76328,6 +93499,138 @@ "StudentTranscript" ] }, + "/ed-fi/courses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCoursesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courses" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCoursesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courses" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/courses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -76363,7 +93666,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76395,15 +93698,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -76430,7 +93724,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -76487,7 +93781,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76801,6 +94095,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CredentialEventTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CredentialEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CredentialEventTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CredentialEventTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialEventTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -76917,7 +94272,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -76960,7 +94315,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76981,6 +94336,126 @@ "Credential" ] }, + "/ed-fi/credentialEventTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialEventTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialEventTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "credentialEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/credentialEventTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialEventTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialEventTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "credentialEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/credentialEventTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -77016,7 +94491,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77048,15 +94523,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -77083,7 +94549,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77140,7 +94606,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77432,6 +94898,77 @@ "credentialEventTypeDescriptor" ], "type": "object" + }, + "EdFi_CredentialEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CredentialEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CredentialEvent_TrackedChangeKey": { + "properties": { + "credentialEventDate": { + "format": "date", + "type": "string" + }, + "credentialEventTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "credentialIdentifier": { + "maxLength": 120, + "type": "string" + }, + "stateOfIssueStateAbbreviationDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "credentialEventDate", + "credentialEventTypeDescriptor", + "credentialIdentifier", + "stateOfIssueStateAbbreviationDescriptor" + ], + "type": "object" + }, + "EdFi_CredentialEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -77541,7 +95078,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77584,7 +95121,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77605,6 +95142,126 @@ "Credential" ] }, + "/ed-fi/credentialEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "credentialEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/credentialEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "credentialEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/credentialEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -77640,7 +95297,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77672,15 +95329,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -77707,7 +95355,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77764,7 +95412,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77985,6 +95633,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CredentialFieldDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CredentialFieldDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CredentialFieldDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -78101,7 +95810,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78144,7 +95853,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78166,6 +95875,128 @@ "Staff" ] }, + "/ed-fi/credentialFieldDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialFieldsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "credentialFieldDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, + "/ed-fi/credentialFieldDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialFieldsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "credentialFieldDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, "/ed-fi/credentialFieldDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -78201,7 +96032,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78233,15 +96064,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -78268,7 +96090,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78325,7 +96147,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78554,6 +96376,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CredentialStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CredentialStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CredentialStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CredentialStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -78670,7 +96553,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78713,7 +96596,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78735,6 +96618,128 @@ "Staff" ] }, + "/ed-fi/credentialStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "credentialStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, + "/ed-fi/credentialStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "credentialStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, "/ed-fi/credentialStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -78770,7 +96775,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78802,15 +96807,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -78837,7 +96833,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78894,7 +96890,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79123,6 +97119,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CredentialTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CredentialTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CredentialTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -79239,7 +97296,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79282,7 +97339,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79304,6 +97361,128 @@ "Staff" ] }, + "/ed-fi/credentialTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "credentialTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, + "/ed-fi/credentialTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "credentialTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, "/ed-fi/credentialTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -79339,7 +97518,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79371,15 +97550,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -79406,7 +97576,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79463,7 +97633,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -80313,6 +98483,67 @@ "studentAcademicRecordReference" ], "type": "object" + }, + "EdFi_Credential_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Credential_TrackedChangeKey": { + "properties": { + "credentialIdentifier": { + "maxLength": 120, + "type": "string" + }, + "stateOfIssueStateAbbreviationDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "credentialIdentifier", + "stateOfIssueStateAbbreviationDescriptor" + ], + "type": "object" + }, + "EdFi_Credential_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -80561,7 +98792,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80604,7 +98835,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -80626,6 +98857,128 @@ "Staff" ] }, + "/ed-fi/credentials/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "credentials" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, + "/ed-fi/credentials/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "credentials" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, "/ed-fi/credentials/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -80661,7 +99014,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -80693,15 +99046,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -80728,7 +99072,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80785,7 +99129,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81109,6 +99453,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CreditCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CreditCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CreditCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -81225,7 +99630,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81268,7 +99673,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81294,6 +99699,136 @@ "StudentTranscript" ] }, + "/ed-fi/creditCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCreditCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "creditCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/creditCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCreditCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "creditCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/creditCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -81329,7 +99864,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81361,15 +99896,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -81396,7 +99922,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81453,7 +99979,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81701,6 +100227,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CreditTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CreditTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CreditTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -81817,7 +100404,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81860,7 +100447,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81897,6 +100484,158 @@ "StudentTranscript" ] }, + "/ed-fi/creditTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCreditTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "creditTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Enrollment", + "Graduation", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/creditTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCreditTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "creditTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Enrollment", + "Graduation", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/creditTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -81932,7 +100671,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81964,15 +100703,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -81999,7 +100729,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82056,7 +100786,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82330,6 +101060,62 @@ "crisisEventName" ], "type": "object" + }, + "EdFi_CrisisEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CrisisEvent_TrackedChangeKey": { + "properties": { + "crisisEventName": { + "maxLength": 100, + "type": "string" + } + }, + "required": [ + "crisisEventName" + ], + "type": "object" + }, + "EdFi_CrisisEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -82436,7 +101222,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82479,7 +101265,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82500,6 +101286,126 @@ "Enrollment" ] }, + "/ed-fi/crisisEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCrisisEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "crisisEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/crisisEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCrisisEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "crisisEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/crisisEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -82535,7 +101441,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82567,15 +101473,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -82602,7 +101499,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82659,7 +101556,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82879,6 +101776,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CrisisTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CrisisTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CrisisTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -82995,7 +101953,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83038,7 +101996,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83059,6 +102017,126 @@ "Enrollment" ] }, + "/ed-fi/crisisTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCrisisTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "crisisTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/crisisTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCrisisTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "crisisTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/crisisTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -83094,7 +102172,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83126,15 +102204,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -83161,7 +102230,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83218,7 +102287,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83445,6 +102514,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CteProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CteProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CteProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -83561,7 +102691,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83604,7 +102734,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83625,6 +102755,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/cteProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCTEProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "cteProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/cteProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCTEProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "cteProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/cteProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -83660,7 +102910,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83692,15 +102942,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -83727,7 +102968,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83784,7 +103025,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84014,6 +103255,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CurriculumUsedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CurriculumUsedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CurriculumUsedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -84130,7 +103432,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84173,7 +103475,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84197,6 +103499,132 @@ "SectionsAndPrograms" ] }, + "/ed-fi/curriculumUsedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCurriculumUsedsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "curriculumUsedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/curriculumUsedDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCurriculumUsedsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "curriculumUsedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/curriculumUsedDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -84232,7 +103660,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84264,15 +103692,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -84299,7 +103718,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84356,7 +103775,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84586,6 +104005,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DegreeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DegreeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DegreeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DegreeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DegreeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DegreeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -84702,7 +104182,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84745,7 +104225,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84766,6 +104246,126 @@ "Credential" ] }, + "/ed-fi/degreeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDegreesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DegreeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "degreeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/degreeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDegreesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DegreeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "degreeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/degreeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -84801,7 +104401,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84833,15 +104433,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -84868,7 +104459,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84925,7 +104516,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85153,6 +104744,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DeliveryMethodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DeliveryMethodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DeliveryMethodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -85269,7 +104921,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85312,7 +104964,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85334,6 +104986,128 @@ "StudentCohort" ] }, + "/ed-fi/deliveryMethodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDeliveryMethodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "deliveryMethodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/deliveryMethodDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDeliveryMethodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "deliveryMethodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/deliveryMethodDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -85369,7 +105143,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85401,15 +105175,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -85436,7 +105201,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85493,7 +105258,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85822,6 +105587,79 @@ "value" ], "type": "object" + }, + "EdFi_DescriptorMapping_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DescriptorMapping_TrackedChangeKey": { + "properties": { + "mappedNamespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "mappedValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "value": { + "maxLength": 50, + "type": "string" + } + }, + "required": [ + "mappedNamespace", + "mappedValue", + "namespace", + "value" + ], + "type": "object" + }, + "EdFi_DescriptorMapping_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -85924,7 +105762,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85967,7 +105805,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85988,6 +105826,126 @@ "EducationOrganization" ] }, + "/ed-fi/descriptorMappings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDescriptorMappingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "descriptorMappings" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/descriptorMappings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDescriptorMappingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "descriptorMappings" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/descriptorMappings/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -86023,7 +105981,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86055,15 +106013,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -86090,7 +106039,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86147,7 +106096,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86363,6 +106312,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DiagnosisDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DiagnosisDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DiagnosisDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -86479,7 +106489,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86522,7 +106532,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86544,6 +106554,128 @@ "StudentCohort" ] }, + "/ed-fi/diagnosisDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDiagnosesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "diagnosisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/diagnosisDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDiagnosesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "diagnosisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/diagnosisDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -86579,7 +106711,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86611,15 +106743,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -86646,7 +106769,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86703,7 +106826,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86935,6 +107058,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DiplomaLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DiplomaLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DiplomaLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -87051,7 +107235,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87094,7 +107278,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87119,6 +107303,134 @@ "StudentTranscript" ] }, + "/ed-fi/diplomaLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "diplomaLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/diplomaLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "diplomaLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/diplomaLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -87154,7 +107466,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87186,15 +107498,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -87221,7 +107524,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87278,7 +107581,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87513,6 +107816,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DiplomaTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DiplomaTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DiplomaTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -87629,7 +107993,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87672,7 +108036,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87697,6 +108061,134 @@ "StudentTranscript" ] }, + "/ed-fi/diplomaTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "diplomaTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/diplomaTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "diplomaTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/diplomaTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -87732,7 +108224,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87764,15 +108256,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -87799,7 +108282,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87856,7 +108339,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -88092,6 +108575,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -88208,7 +108752,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88251,7 +108795,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -88277,6 +108821,136 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/disabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilitiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "disabilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "SpecialEducation", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/disabilityDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilitiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "disabilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "SpecialEducation", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/disabilityDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -88312,7 +108986,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -88344,15 +109018,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -88379,7 +109044,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88436,7 +109101,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -88673,6 +109338,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisabilityDesignationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisabilityDesignationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisabilityDesignationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -88789,7 +109515,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88832,7 +109558,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -88858,6 +109584,136 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/disabilityDesignationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDesignationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "disabilityDesignationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "SpecialEducation", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/disabilityDesignationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDesignationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "disabilityDesignationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "SpecialEducation", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/disabilityDesignationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -88893,7 +109749,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -88925,15 +109781,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -88960,7 +109807,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89017,7 +109864,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89254,6 +110101,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -89370,7 +110278,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89413,7 +110321,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89439,6 +110347,136 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/disabilityDeterminationSourceTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDeterminationSourceTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "disabilityDeterminationSourceTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "SpecialEducation", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/disabilityDeterminationSourceTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDeterminationSourceTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "disabilityDeterminationSourceTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "SpecialEducation", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/disabilityDeterminationSourceTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -89474,7 +110512,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89506,15 +110544,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -89541,7 +110570,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89598,7 +110627,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89830,6 +110859,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -89946,7 +111036,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89989,7 +111079,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90010,6 +111100,126 @@ "Discipline" ] }, + "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionLengthDifferenceReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "disciplineActionLengthDifferenceReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionLengthDifferenceReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "disciplineActionLengthDifferenceReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -90045,7 +111255,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90077,15 +111287,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -90112,7 +111313,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90169,7 +111370,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90816,6 +112017,72 @@ "studentDisciplineIncidentBehaviorAssociationReference" ], "type": "object" + }, + "EdFi_DisciplineAction_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineAction_TrackedChangeKey": { + "properties": { + "disciplineActionIdentifier": { + "maxLength": 36, + "type": "string" + }, + "disciplineDate": { + "format": "date", + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "disciplineActionIdentifier", + "disciplineDate", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_DisciplineAction_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -90969,7 +112236,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91012,7 +112279,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -91033,6 +112300,126 @@ "Discipline" ] }, + "/ed-fi/disciplineActions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "disciplineActions" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineActions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "disciplineActions" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/disciplineActions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -91068,7 +112455,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -91100,15 +112487,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -91135,7 +112513,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91192,7 +112570,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -91453,6 +112831,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisciplineDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisciplineDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -91569,7 +113008,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91612,7 +113051,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -91633,6 +113072,126 @@ "Discipline" ] }, + "/ed-fi/disciplineDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplinesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "disciplineDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplinesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "disciplineDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/disciplineDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -91668,7 +113227,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -91700,15 +113259,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -91735,7 +113285,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91792,7 +113342,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92019,6 +113569,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -92135,7 +113746,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92178,7 +113789,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92199,6 +113810,126 @@ "Discipline" ] }, + "/ed-fi/disciplineIncidentParticipationCodeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentParticipationCodesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "disciplineIncidentParticipationCodeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineIncidentParticipationCodeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentParticipationCodesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "disciplineIncidentParticipationCodeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/disciplineIncidentParticipationCodeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -92234,7 +113965,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92266,15 +113997,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -92301,7 +114023,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92358,7 +114080,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92969,6 +114691,67 @@ ], "type": "object" }, + "EdFi_DisciplineIncident_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineIncident_TrackedChangeKey": { + "properties": { + "incidentIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "incidentIdentifier", + "schoolId" + ], + "type": "object" + }, + "EdFi_DisciplineIncident_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_DisciplineIncident_Weapon": { "properties": { "weaponDescriptor": { @@ -93140,7 +114923,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93183,7 +114966,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93204,6 +114987,126 @@ "Discipline" ] }, + "/ed-fi/disciplineIncidents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "disciplineIncidents" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineIncidents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "disciplineIncidents" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/disciplineIncidents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -93239,7 +115142,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93271,15 +115174,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -93306,7 +115200,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93363,7 +115257,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93629,6 +115523,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisplacedStudentStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -93745,7 +115700,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93788,7 +115743,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93810,6 +115765,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/displacedStudentStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisplacedStudentStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "displacedStudentStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/displacedStudentStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisplacedStudentStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "displacedStudentStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/displacedStudentStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -93845,7 +115922,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93877,15 +115954,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -93912,7 +115980,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93969,7 +116037,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94205,6 +116273,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DualCreditInstitutionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DualCreditInstitutionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DualCreditInstitutionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -94321,7 +116450,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94364,7 +116493,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94393,6 +116522,142 @@ "SectionsAndPrograms" ] }, + "/ed-fi/dualCreditInstitutionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDualCreditInstitutionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "dualCreditInstitutionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/dualCreditInstitutionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDualCreditInstitutionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "dualCreditInstitutionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/dualCreditInstitutionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -94428,7 +116693,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94460,15 +116725,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -94495,7 +116751,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94552,7 +116808,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94795,6 +117051,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DualCreditTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DualCreditTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DualCreditTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -94911,7 +117228,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94954,7 +117271,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94983,6 +117300,142 @@ "SectionsAndPrograms" ] }, + "/ed-fi/dualCreditTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDualCreditTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "dualCreditTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/dualCreditTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDualCreditTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "dualCreditTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/dualCreditTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -95018,7 +117471,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95050,15 +117503,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -95085,7 +117529,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95142,7 +117586,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95377,6 +117821,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EconomicDisadvantageDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EconomicDisadvantageDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EconomicDisadvantageDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EconomicDisadvantageDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EconomicDisadvantageDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EconomicDisadvantageDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -95493,7 +117998,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95536,7 +118041,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95557,6 +118062,126 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/economicDisadvantageDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEconomicDisadvantagesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EconomicDisadvantageDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "economicDisadvantageDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/economicDisadvantageDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEconomicDisadvantagesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EconomicDisadvantageDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "economicDisadvantageDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/economicDisadvantageDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -95592,7 +118217,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95624,15 +118249,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -95659,7 +118275,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95716,7 +118332,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96581,6 +119197,62 @@ "contentIdentifier" ], "type": "object" + }, + "EdFi_EducationContent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationContent_TrackedChangeKey": { + "properties": { + "contentIdentifier": { + "maxLength": 225, + "type": "string" + } + }, + "required": [ + "contentIdentifier" + ], + "type": "object" + }, + "EdFi_EducationContent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -96798,7 +119470,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -96841,7 +119513,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96862,6 +119534,126 @@ "Intervention" ] }, + "/ed-fi/educationContents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationContentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationContents" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/educationContents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationContentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationContents" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, "/ed-fi/educationContents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -96897,7 +119689,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96929,15 +119721,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -96964,7 +119747,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97021,7 +119804,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -97319,6 +120102,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -97435,7 +120279,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97478,7 +120322,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -97499,6 +120343,126 @@ "Assessment" ] }, + "/ed-fi/educationOrganizationAssociationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationAssociationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationOrganizationAssociationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, + "/ed-fi/educationOrganizationAssociationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationAssociationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationOrganizationAssociationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, "/ed-fi/educationOrganizationAssociationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -97534,7 +120498,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -97566,15 +120530,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -97601,7 +120556,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97658,7 +120613,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -97903,6 +120858,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -98019,7 +121035,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98062,7 +121078,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98101,6 +121117,162 @@ "StudentTranscript" ] }, + "/ed-fi/educationOrganizationCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationOrganizationCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/educationOrganizationCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationOrganizationCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/educationOrganizationCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -98136,7 +121308,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98168,15 +121340,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -98203,7 +121366,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98260,7 +121423,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98542,6 +121705,67 @@ "educationOrganizationIdentificationSystemDescriptor" ], "type": "object" + }, + "EdFi_EducationOrganizationIdentificationCode_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationIdentificationCode_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "educationOrganizationIdentificationSystemDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "educationOrganizationIdentificationSystemDescriptor" + ], + "type": "object" + }, + "EdFi_EducationOrganizationIdentificationCode_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationCode_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -98640,7 +121864,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98683,7 +121907,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98704,6 +121928,126 @@ "EducationOrganization" ] }, + "/ed-fi/educationOrganizationIdentificationCodes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationIdentificationCodesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationCode_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationOrganizationIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationIdentificationCodes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationIdentificationCodesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationCode_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationOrganizationIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/educationOrganizationIdentificationCodes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -98739,7 +122083,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98771,15 +122115,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -98806,7 +122141,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98863,7 +122198,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -99099,6 +122434,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -99215,7 +122611,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99258,7 +122654,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -99297,6 +122693,162 @@ "StudentTranscript" ] }, + "/ed-fi/educationOrganizationIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationIdentificationSystemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationOrganizationIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/educationOrganizationIdentificationSystemDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationIdentificationSystemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationOrganizationIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/educationOrganizationIdentificationSystemDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -99332,7 +122884,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -99364,15 +122916,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -99399,7 +122942,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99456,7 +122999,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -99771,6 +123314,72 @@ "interventionPrescriptionIdentificationCode" ], "type": "object" + }, + "EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionPrescriptionEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionPrescriptionIdentificationCode": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionPrescriptionEducationOrganizationId", + "interventionPrescriptionIdentificationCode" + ], + "type": "object" + }, + "EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -99879,7 +123488,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99922,7 +123531,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -99943,6 +123552,126 @@ "Intervention" ] }, + "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationOrganizationInterventionPrescriptionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationOrganizationInterventionPrescriptionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -99978,7 +123707,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100010,15 +123739,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -100045,7 +123765,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100102,7 +123822,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100381,6 +124101,67 @@ "memberEducationOrganizationId" ], "type": "object" + }, + "EdFi_EducationOrganizationNetworkAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationNetworkId": { + "format": "int64", + "type": "integer" + }, + "memberEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationOrganizationNetworkId", + "memberEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -100479,7 +124260,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100522,7 +124303,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100543,6 +124324,126 @@ "EducationOrganization" ] }, + "/ed-fi/educationOrganizationNetworkAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworkAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationOrganizationNetworkAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationNetworkAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworkAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationOrganizationNetworkAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/educationOrganizationNetworkAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -100578,7 +124479,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100610,15 +124511,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -100645,7 +124537,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100702,7 +124594,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -101647,6 +125539,62 @@ ], "type": "object" }, + "EdFi_EducationOrganizationNetwork_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetwork_TrackedChangeKey": { + "properties": { + "educationOrganizationNetworkId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationOrganizationNetworkId" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetwork_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_EducationOrganization_Address": { "properties": { "addressTypeDescriptor": { @@ -102025,7 +125973,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102068,7 +126016,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -102089,6 +126037,126 @@ "EducationOrganization" ] }, + "/ed-fi/educationOrganizationNetworks/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworksDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationOrganizationNetworks" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationNetworks/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworksKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationOrganizationNetworks" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/educationOrganizationNetworks/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -102124,7 +126192,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -102156,15 +126224,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -102191,7 +126250,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102248,7 +126307,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -102500,6 +126559,67 @@ "peerEducationOrganizationId" ], "type": "object" + }, + "EdFi_EducationOrganizationPeerAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "peerEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationOrganizationId", + "peerEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_EducationOrganizationPeerAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -102580,7 +126700,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102623,7 +126743,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -102644,6 +126764,126 @@ "EducationOrganization" ] }, + "/ed-fi/educationOrganizationPeerAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationPeerAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationOrganizationPeerAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationPeerAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationPeerAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationOrganizationPeerAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/educationOrganizationPeerAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -102679,7 +126919,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -102711,15 +126951,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -102746,7 +126977,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102803,7 +127034,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -103018,6 +127249,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationPlanDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationPlanDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationPlanDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -103134,7 +127426,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -103177,7 +127469,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -103202,6 +127494,134 @@ "SectionsAndPrograms" ] }, + "/ed-fi/educationPlanDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationPlansDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationPlanDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/educationPlanDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationPlansKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationPlanDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/educationPlanDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -103237,7 +127657,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -103269,15 +127689,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -103304,7 +127715,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -103361,7 +127772,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -104589,6 +129000,62 @@ "educationServiceCenterId" ], "type": "object" + }, + "EdFi_EducationServiceCenter_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationServiceCenter_TrackedChangeKey": { + "properties": { + "educationServiceCenterId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationServiceCenterId" + ], + "type": "object" + }, + "EdFi_EducationServiceCenter_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -104706,7 +129173,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104749,7 +129216,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -104771,6 +129238,128 @@ "Staff" ] }, + "/ed-fi/educationServiceCenters/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationServiceCentersDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationServiceCenters" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, + "/ed-fi/educationServiceCenters/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationServiceCentersKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationServiceCenters" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, "/ed-fi/educationServiceCenters/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -104806,7 +129395,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -104838,15 +129427,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -104873,7 +129453,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104930,7 +129510,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -105184,6 +129764,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationalEnvironmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationalEnvironmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -105300,7 +129941,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -105343,7 +129984,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -105377,6 +130018,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/educationalEnvironmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationalEnvironmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationalEnvironmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Intervention", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/educationalEnvironmentDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationalEnvironmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationalEnvironmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Intervention", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/educationalEnvironmentDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -105412,7 +130199,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -105444,15 +130231,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -105479,7 +130257,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -105536,7 +130314,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -105901,6 +130679,73 @@ "programTypeDescriptor" ], "type": "object" + }, + "EdFi_EducatorPreparationProgram_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducatorPreparationProgram_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducatorPreparationProgram_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_EducatorPreparationProgram_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducatorPreparationProgram_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducatorPreparationProgram_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -106010,7 +130855,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106053,7 +130898,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106074,6 +130919,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/educatorPreparationPrograms/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducatorPreparationProgramsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducatorPreparationProgram_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educatorPreparationPrograms" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/educatorPreparationPrograms/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducatorPreparationProgramsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducatorPreparationProgram_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educatorPreparationPrograms" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/educatorPreparationPrograms/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -106109,7 +131074,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106141,15 +131106,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -106176,7 +131132,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106233,7 +131189,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106458,6 +131414,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducatorRoleDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducatorRoleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducatorRoleDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducatorRoleDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducatorRoleDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducatorRoleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -106574,7 +131591,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106617,7 +131634,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106639,6 +131656,128 @@ "Staff" ] }, + "/ed-fi/educatorRoleDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducatorRolesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducatorRoleDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educatorRoleDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, + "/ed-fi/educatorRoleDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducatorRolesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducatorRoleDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educatorRoleDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, "/ed-fi/educatorRoleDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -106674,7 +131813,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106706,15 +131845,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -106741,7 +131871,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106798,7 +131928,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107040,6 +132170,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ElectronicMailTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ElectronicMailTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -107156,7 +132347,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107199,7 +132390,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107234,6 +132425,154 @@ "SectionsAndPrograms" ] }, + "/ed-fi/electronicMailTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getElectronicMailTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "electronicMailTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Intervention", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/electronicMailTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getElectronicMailTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "electronicMailTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Intervention", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/electronicMailTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -107269,7 +132608,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107301,15 +132640,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -107336,7 +132666,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107393,7 +132723,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107634,6 +132964,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EligibilityDelayReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -107750,7 +133141,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107793,7 +133184,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107814,6 +133205,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/eligibilityDelayReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityDelayReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "eligibilityDelayReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/eligibilityDelayReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityDelayReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "eligibilityDelayReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/eligibilityDelayReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -107849,7 +133360,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107881,15 +133392,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -107916,7 +133418,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107973,7 +133475,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108200,6 +133702,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -108316,7 +133879,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108359,7 +133922,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108380,6 +133943,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/eligibilityEvaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityEvaluationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "eligibilityEvaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/eligibilityEvaluationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityEvaluationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "eligibilityEvaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/eligibilityEvaluationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -108415,7 +134098,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108447,15 +134130,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -108482,7 +134156,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108539,7 +134213,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108766,6 +134440,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EmploymentStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EmploymentStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EmploymentStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -108882,7 +134617,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108925,7 +134660,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108946,6 +134681,126 @@ "Staff" ] }, + "/ed-fi/employmentStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEmploymentStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "employmentStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/employmentStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEmploymentStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "employmentStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/employmentStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -108981,7 +134836,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109013,15 +134868,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -109048,7 +134894,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109105,7 +134951,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109332,6 +135178,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EnglishLanguageExamDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EnglishLanguageExamDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EnglishLanguageExamDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EnglishLanguageExamDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EnglishLanguageExamDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EnglishLanguageExamDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -109448,7 +135355,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109491,7 +135398,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109512,6 +135419,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/englishLanguageExamDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEnglishLanguageExamsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EnglishLanguageExamDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "englishLanguageExamDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/englishLanguageExamDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEnglishLanguageExamsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EnglishLanguageExamDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "englishLanguageExamDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/englishLanguageExamDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -109547,7 +135574,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109579,15 +135606,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -109614,7 +135632,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109671,7 +135689,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109902,6 +135920,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EnrollmentTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EnrollmentTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EnrollmentTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -110018,7 +136097,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110061,7 +136140,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -110086,6 +136165,134 @@ "SectionsAndPrograms" ] }, + "/ed-fi/enrollmentTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEnrollmentTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "enrollmentTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/enrollmentTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEnrollmentTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "enrollmentTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/enrollmentTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -110121,7 +136328,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -110153,15 +136360,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -110188,7 +136386,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110245,7 +136443,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -110480,6 +136678,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -110596,7 +136855,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110639,7 +136898,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -110664,6 +136923,134 @@ "SectionsAndPrograms" ] }, + "/ed-fi/entryGradeLevelReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEntryGradeLevelReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "entryGradeLevelReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/entryGradeLevelReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEntryGradeLevelReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "entryGradeLevelReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/entryGradeLevelReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -110699,7 +137086,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -110731,15 +137118,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -110766,7 +137144,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110823,7 +137201,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111058,6 +137436,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EntryTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EntryTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EntryTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -111174,7 +137613,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111217,7 +137656,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111242,6 +137681,134 @@ "SectionsAndPrograms" ] }, + "/ed-fi/entryTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEntryTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "entryTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/entryTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEntryTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "entryTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/entryTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -111277,7 +137844,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111309,15 +137876,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -111344,7 +137902,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111401,7 +137959,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111632,6 +138190,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EppDegreeTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EppDegreeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EppDegreeTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EppDegreeTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EppDegreeTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EppDegreeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -111748,7 +138367,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111791,7 +138410,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111812,6 +138431,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/eppDegreeTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEPPDegreeTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EppDegreeTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "eppDegreeTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/eppDegreeTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEPPDegreeTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EppDegreeTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "eppDegreeTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/eppDegreeTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -111847,7 +138586,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111879,15 +138618,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -111914,7 +138644,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111971,7 +138701,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112198,6 +138928,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EppProgramPathwayDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EppProgramPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EppProgramPathwayDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EppProgramPathwayDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EppProgramPathwayDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EppProgramPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -112314,7 +139105,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112357,7 +139148,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112378,6 +139169,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/eppProgramPathwayDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEPPProgramPathwaysDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EppProgramPathwayDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "eppProgramPathwayDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/eppProgramPathwayDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEPPProgramPathwaysKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EppProgramPathwayDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "eppProgramPathwayDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/eppProgramPathwayDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -112413,7 +139324,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112445,15 +139356,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -112480,7 +139382,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112537,7 +139439,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112764,6 +139666,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EvaluationDelayReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -112880,7 +139843,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112923,7 +139886,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112944,6 +139907,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/evaluationDelayReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationDelayReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationDelayReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/evaluationDelayReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationDelayReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationDelayReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/evaluationDelayReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -112979,7 +140062,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -113011,15 +140094,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -113046,7 +140120,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -113103,7 +140177,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -113330,6 +140404,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EvaluationElementRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationElementRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EvaluationElementRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -113446,7 +140581,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -113489,7 +140624,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -113510,6 +140645,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationElementRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationElementRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationElementRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationElementRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationElementRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationElementRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationElementRatingLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -113545,7 +140800,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -113577,15 +140832,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -113612,7 +140858,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -113669,7 +140915,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -114490,6 +141736,121 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "EdFi_EvaluationElementRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationElementRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationDate": { + "format": "date-time", + "type": "string" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationDate", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_EvaluationElementRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -114723,7 +142084,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114766,7 +142127,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -114787,6 +142148,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationElementRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationElementRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationElementRatings" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationElementRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationElementRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationElementRatings" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationElementRatings/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -114822,7 +142303,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -114854,15 +142335,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -114889,7 +142361,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114946,7 +142418,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -115585,6 +143057,106 @@ "evaluationObjectiveTitle" ], "type": "object" + }, + "EdFi_EvaluationElement_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationElement_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_EvaluationElement_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElement_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -115775,7 +143347,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -115818,7 +143390,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -115839,6 +143411,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationElements/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationElementsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationElement_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationElements" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationElements/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationElementsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationElement_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationElements" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationElements/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -115874,7 +143566,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -115906,15 +143598,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -115941,7 +143624,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -115998,7 +143681,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -116766,6 +144449,115 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "EdFi_EvaluationObjectiveRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationObjectiveRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationObjectiveRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationDate": { + "format": "date-time", + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationDate", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_EvaluationObjectiveRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationObjectiveRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationObjectiveRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -116958,7 +144750,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -117001,7 +144793,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -117022,6 +144814,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationObjectiveRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationObjectiveRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationObjectiveRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationObjectiveRatings" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationObjectiveRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationObjectiveRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationObjectiveRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationObjectiveRatings" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationObjectiveRatings/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -117057,7 +144969,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -117089,15 +145001,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -117124,7 +145027,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -117181,7 +145084,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -117792,6 +145695,100 @@ "evaluationObjectiveTitle" ], "type": "object" + }, + "EdFi_EvaluationObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationObjective_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_EvaluationObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -117980,7 +145977,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118023,7 +146020,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118044,6 +146041,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationObjectivesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationObjectives/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationObjectivesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationObjective_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationObjectives/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -118079,7 +146196,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118111,15 +146228,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -118146,7 +146254,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118203,7 +146311,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118482,6 +146590,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EvaluationPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EvaluationPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -118598,7 +146767,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118641,7 +146810,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118662,6 +146831,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationPeriodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationPeriodDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationPeriodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationPeriodDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -118697,7 +146986,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118729,15 +147018,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -118764,7 +147044,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118821,7 +147101,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119048,6 +147328,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EvaluationRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EvaluationRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -119164,7 +147505,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119207,7 +147548,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119228,6 +147569,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationRatingLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -119263,7 +147724,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119295,15 +147756,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -119330,7 +147782,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119387,7 +147839,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119616,6 +148068,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EvaluationRatingStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationRatingStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EvaluationRatingStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -119732,7 +148245,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119775,7 +148288,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119798,6 +148311,130 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/evaluationRatingStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRatingStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationRatingStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation", + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/evaluationRatingStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRatingStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationRatingStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation", + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/evaluationRatingStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -119833,7 +148470,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119865,15 +148502,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -119900,7 +148528,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119957,7 +148585,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120917,6 +149545,109 @@ "lastSurname" ], "type": "object" + }, + "EdFi_EvaluationRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationDate": { + "format": "date-time", + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationDate", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_EvaluationRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -121156,7 +149887,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121199,7 +149930,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121220,6 +149951,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationRatings" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationRatings" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationRatings/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -121255,7 +150106,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121287,15 +150138,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -121322,7 +150164,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121379,7 +150221,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121868,6 +150710,97 @@ "programEvaluationElementTitle" ], "type": "object" + }, + "EdFi_EvaluationRubricDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationRubricDimension_TrackedChangeKey": { + "properties": { + "evaluationRubricRating": { + "format": "int32", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationElementTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "evaluationRubricRating", + "programEducationOrganizationId", + "programEvaluationElementTitle", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_EvaluationRubricDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -122035,7 +150968,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122078,7 +151011,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -122100,6 +151033,128 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/evaluationRubricDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRubricDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationRubricDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/evaluationRubricDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRubricDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationRubricDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/evaluationRubricDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -122135,7 +151190,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -122167,15 +151222,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -122202,7 +151248,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122259,7 +151305,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -122520,6 +151566,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -122636,7 +151743,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122679,7 +151786,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -122700,6 +151807,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -122735,7 +151962,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -122767,15 +151994,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -122802,7 +152020,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122859,7 +152077,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -123393,6 +152611,94 @@ "termDescriptor" ], "type": "object" + }, + "EdFi_Evaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Evaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Evaluation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_Evaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Evaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Evaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -123570,7 +152876,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123613,7 +152919,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -123634,6 +152940,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Evaluation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluations" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Evaluation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluations" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -123669,7 +153095,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -123701,15 +153127,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -123736,7 +153153,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123793,7 +153210,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124067,6 +153484,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EventCircumstanceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EventCircumstanceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EventCircumstanceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -124183,7 +153661,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124226,7 +153704,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124248,6 +153726,128 @@ "StudentAssessment" ] }, + "/ed-fi/eventCircumstanceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEventCircumstancesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "eventCircumstanceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/eventCircumstanceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEventCircumstancesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "eventCircumstanceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, "/ed-fi/eventCircumstanceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -124283,7 +153883,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124315,15 +153915,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -124350,7 +153941,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124407,7 +153998,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124639,6 +154230,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ExitWithdrawTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -124755,7 +154407,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124798,7 +154450,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124823,6 +154475,134 @@ "SectionsAndPrograms" ] }, + "/ed-fi/exitWithdrawTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getExitWithdrawTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "exitWithdrawTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/exitWithdrawTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getExitWithdrawTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "exitWithdrawTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/exitWithdrawTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -124858,7 +154638,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124890,15 +154670,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -124925,7 +154696,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124982,7 +154753,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -125226,6 +154997,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_FederalLocaleCodeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FederalLocaleCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FederalLocaleCodeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_FederalLocaleCodeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FederalLocaleCodeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FederalLocaleCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -125342,7 +155174,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125385,7 +155217,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -125419,6 +155251,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/federalLocaleCodeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFederalLocaleCodesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FederalLocaleCodeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "federalLocaleCodeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/federalLocaleCodeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFederalLocaleCodesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FederalLocaleCodeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "federalLocaleCodeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/federalLocaleCodeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -125454,7 +155432,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -125486,15 +155464,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -125521,7 +155490,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125578,7 +155547,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -125896,6 +155865,72 @@ "schoolId" ], "type": "object" + }, + "EdFi_FeederSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FeederSchoolAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "feederSchoolId": { + "format": "int64", + "type": "integer" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "beginDate", + "feederSchoolId", + "schoolId" + ], + "type": "object" + }, + "EdFi_FeederSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -126004,7 +156039,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126047,7 +156082,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126068,6 +156103,126 @@ "EducationOrganization" ] }, + "/ed-fi/feederSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFeederSchoolAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "feederSchoolAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/feederSchoolAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFeederSchoolAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "feederSchoolAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/feederSchoolAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -126103,7 +156258,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126135,15 +156290,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -126170,7 +156316,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126227,7 +156373,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126593,6 +156739,98 @@ "sectionIdentifier" ], "type": "object" + }, + "EdFi_FieldworkExperienceSectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkExperienceSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FieldworkExperienceSectionAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "fieldworkIdentifier": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "fieldworkIdentifier", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_FieldworkExperienceSectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkExperienceSectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkExperienceSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -126734,7 +156972,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126777,7 +157015,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126798,6 +157036,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/fieldworkExperienceSectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFieldworkExperienceSectionAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FieldworkExperienceSectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "fieldworkExperienceSectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/fieldworkExperienceSectionAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFieldworkExperienceSectionAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FieldworkExperienceSectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "fieldworkExperienceSectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/fieldworkExperienceSectionAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -126833,7 +157191,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126865,15 +157223,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -126900,7 +157249,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126957,7 +157306,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127443,6 +157792,73 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_FieldworkExperience_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkExperience_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FieldworkExperience_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "fieldworkIdentifier": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "fieldworkIdentifier", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_FieldworkExperience_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkExperience_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkExperience_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -127602,7 +158018,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127645,7 +158061,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127666,6 +158082,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/fieldworkExperiences/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFieldworkExperiencesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FieldworkExperience_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "fieldworkExperiences" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/fieldworkExperiences/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFieldworkExperiencesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FieldworkExperience_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "fieldworkExperiences" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/fieldworkExperiences/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -127701,7 +158237,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127733,15 +158269,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -127768,7 +158295,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127825,7 +158352,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128076,6 +158603,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_FieldworkTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FieldworkTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_FieldworkTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -128192,7 +158780,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128235,7 +158823,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128256,6 +158844,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/fieldworkTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFieldworkTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FieldworkTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "fieldworkTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/fieldworkTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFieldworkTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FieldworkTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "fieldworkTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/fieldworkTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -128291,7 +158999,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128323,15 +159031,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -128358,7 +159057,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128415,7 +159114,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128747,6 +159446,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_FinancialAid_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FinancialAid_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FinancialAid_TrackedChangeKey": { + "properties": { + "aidTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "beginDate": { + "format": "date", + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "aidTypeDescriptor", + "beginDate", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_FinancialAid_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FinancialAid_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FinancialAid_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -128872,7 +159637,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128915,7 +159680,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128936,6 +159701,126 @@ "Enrollment" ] }, + "/ed-fi/financialAids/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFinancialAidsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FinancialAid_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "financialAids" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/financialAids/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFinancialAidsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FinancialAid_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "financialAids" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/financialAids/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -128971,7 +159856,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129003,15 +159888,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -129038,7 +159914,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129095,7 +159971,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129328,6 +160204,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_FinancialCollectionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FinancialCollectionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_FinancialCollectionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -129444,7 +160381,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129487,7 +160424,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129508,6 +160445,126 @@ "Finance" ] }, + "/ed-fi/financialCollectionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFinancialCollectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "financialCollectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/financialCollectionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFinancialCollectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "financialCollectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/financialCollectionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -129543,7 +160600,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129575,15 +160632,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -129610,7 +160658,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129667,7 +160715,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129955,6 +161003,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_FunctionDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FunctionDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_FunctionDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -130044,7 +161153,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130087,7 +161196,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130108,6 +161217,126 @@ "Finance" ] }, + "/ed-fi/functionDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFunctionDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "functionDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/functionDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFunctionDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "functionDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/functionDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -130143,7 +161372,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130175,15 +161404,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -130210,7 +161430,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130267,7 +161487,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130536,6 +161756,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_FundDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FundDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_FundDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -130625,7 +161906,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130668,7 +161949,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130689,6 +161970,126 @@ "Finance" ] }, + "/ed-fi/fundDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFundDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "fundDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/fundDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFundDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "fundDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/fundDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -130724,7 +162125,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130756,15 +162157,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -130791,7 +162183,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130848,7 +162240,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131056,6 +162448,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_FundingSourceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FundingSourceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FundingSourceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_FundingSourceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FundingSourceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FundingSourceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -131172,7 +162625,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131215,7 +162668,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131236,6 +162689,126 @@ "Staff" ] }, + "/ed-fi/fundingSourceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFundingSourcesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FundingSourceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "fundingSourceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/fundingSourceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFundingSourcesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FundingSourceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "fundingSourceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/fundingSourceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -131271,7 +162844,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131303,15 +162876,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -131338,7 +162902,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131395,7 +162959,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131622,6 +163186,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GoalTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GoalTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GoalTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GoalTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GoalTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GoalTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -131738,7 +163363,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131781,7 +163406,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131802,6 +163427,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/goalTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGoalTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GoalTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "goalTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/goalTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGoalTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GoalTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "goalTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/goalTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -131837,7 +163582,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131869,15 +163614,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -131904,7 +163640,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131961,7 +163697,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132703,6 +164439,78 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "EdFi_Goal_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Goal_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Goal_TrackedChangeKey": { + "properties": { + "assignmentDate": { + "format": "date", + "type": "string" + }, + "goalTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "assignmentDate", + "goalTitle", + "personId", + "sourceSystemDescriptor" + ], + "type": "object" + }, + "EdFi_Goal_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Goal_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Goal_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -132993,7 +164801,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133036,7 +164844,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133057,6 +164865,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/goals/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGoalsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Goal_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "goals" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/goals/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGoalsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Goal_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "goals" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/goals/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -133092,7 +165020,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133124,15 +165052,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -133159,7 +165078,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133216,7 +165135,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133577,6 +165496,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradeLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradeLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradeLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -133693,7 +165673,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133736,7 +165716,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133785,6 +165765,182 @@ "StudentTranscript" ] }, + "/ed-fi/gradeLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradeLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "gradeLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "AssessmentRegistration", + "BellSchedule", + "Credential", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Graduation", + "Intervention", + "PerformanceEvaluation", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "Standards", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/gradeLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradeLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "gradeLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "AssessmentRegistration", + "BellSchedule", + "Credential", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Graduation", + "Intervention", + "PerformanceEvaluation", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "Standards", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/gradeLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -133820,7 +165976,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133852,15 +166008,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -133887,7 +166034,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133944,7 +166091,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134205,6 +166352,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradePointAverageTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradePointAverageTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -134321,7 +166529,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134364,7 +166572,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134391,6 +166599,138 @@ "StudentTranscript" ] }, + "/ed-fi/gradePointAverageTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradePointAverageTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "gradePointAverageTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation", + "RecruitingAndStaffing", + "StudentAcademicRecord", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/gradePointAverageTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradePointAverageTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "gradePointAverageTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation", + "RecruitingAndStaffing", + "StudentAcademicRecord", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/gradePointAverageTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -134426,7 +166766,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134458,15 +166798,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -134493,7 +166824,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134550,7 +166881,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134784,6 +167115,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradeTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradeTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradeTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -134900,7 +167292,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134943,7 +167335,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134965,6 +167357,128 @@ "ReportCard" ] }, + "/ed-fi/gradeTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradeTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "gradeTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/gradeTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradeTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "gradeTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, "/ed-fi/gradeTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -135000,7 +167514,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135032,15 +167546,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -135067,7 +167572,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135124,7 +167629,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135721,6 +168226,68 @@ "namespace" ], "type": "object" + }, + "EdFi_GradebookEntry_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradebookEntry_TrackedChangeKey": { + "properties": { + "gradebookEntryIdentifier": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "gradebookEntryIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_GradebookEntry_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -135943,7 +168510,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135986,7 +168553,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -136008,6 +168575,128 @@ "Gradebook" ] }, + "/ed-fi/gradebookEntries/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "gradebookEntries" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/gradebookEntries/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "gradebookEntries" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, "/ed-fi/gradebookEntries/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -136043,7 +168732,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -136075,15 +168764,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -136110,7 +168790,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136167,7 +168847,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -136463,6 +169143,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradebookEntryTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradebookEntryTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -136579,7 +169320,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136622,7 +169363,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -136644,6 +169385,128 @@ "Gradebook" ] }, + "/ed-fi/gradebookEntryTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntryTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "gradebookEntryTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/gradebookEntryTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntryTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "gradebookEntryTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, "/ed-fi/gradebookEntryTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -136679,7 +169542,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -136711,15 +169574,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -136746,7 +169600,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136803,7 +169657,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137543,6 +170397,112 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_Grade_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Grade_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "gradeTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "type": "string" + }, + "gradingPeriodSchoolYear": { + "format": "int32", + "type": "integer" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "gradeTypeDescriptor", + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolYear", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_Grade_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -137775,7 +170735,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137818,7 +170778,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137840,6 +170800,128 @@ "ReportCard" ] }, + "/ed-fi/grades/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "grades" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/grades/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "grades" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, "/ed-fi/grades/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -137875,7 +170957,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137907,15 +170989,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -137942,7 +171015,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137999,7 +171072,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138311,6 +171384,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradingPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradingPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradingPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -138427,7 +171561,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138470,7 +171604,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138493,6 +171627,130 @@ "ReportCard" ] }, + "/ed-fi/gradingPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "gradingPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar", + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/gradingPeriodDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "gradingPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar", + "StudentAcademicRecord", + "ReportCard" + ] + }, "/ed-fi/gradingPeriodDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -138528,7 +171786,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138560,15 +171818,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -138595,7 +171844,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138652,7 +171901,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139039,6 +172288,77 @@ "schoolYear" ], "type": "object" + }, + "EdFi_GradingPeriod_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradingPeriod_TrackedChangeKey": { + "properties": { + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "gradingPeriodDescriptor", + "gradingPeriodName", + "schoolId", + "schoolYear" + ], + "type": "object" + }, + "EdFi_GradingPeriod_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -139175,7 +172495,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139218,7 +172538,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139241,6 +172561,130 @@ "ReportCard" ] }, + "/ed-fi/gradingPeriods/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "gradingPeriods" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar", + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/gradingPeriods/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "gradingPeriods" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar", + "StudentAcademicRecord", + "ReportCard" + ] + }, "/ed-fi/gradingPeriods/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -139276,7 +172720,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139308,15 +172752,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -139343,7 +172778,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139400,7 +172835,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139645,6 +173080,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GraduationPlanTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GraduationPlanTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -139761,7 +173257,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139804,7 +173300,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139826,6 +173322,128 @@ "Graduation" ] }, + "/ed-fi/graduationPlanTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlanTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "graduationPlanTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation" + ] + }, + "/ed-fi/graduationPlanTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlanTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "graduationPlanTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation" + ] + }, "/ed-fi/graduationPlanTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -139861,7 +173479,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139893,15 +173511,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -139928,7 +173537,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139985,7 +173594,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141266,6 +174875,72 @@ "certificationTitle" ], "type": "object" + }, + "EdFi_GraduationPlan_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GraduationPlan_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "graduationPlanTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "graduationSchoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "educationOrganizationId", + "graduationPlanTypeDescriptor", + "graduationSchoolYear" + ], + "type": "object" + }, + "EdFi_GraduationPlan_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -141391,7 +175066,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141434,7 +175109,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141456,6 +175131,128 @@ "Graduation" ] }, + "/ed-fi/graduationPlans/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlansDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "graduationPlans" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation" + ] + }, + "/ed-fi/graduationPlans/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlansKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "graduationPlans" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation" + ] + }, "/ed-fi/graduationPlans/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -141491,7 +175288,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141523,15 +175320,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -141558,7 +175346,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141615,7 +175403,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141867,6 +175655,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -141983,7 +175832,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142026,7 +175875,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142049,6 +175898,130 @@ "Staff" ] }, + "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGunFreeSchoolsActReportingStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "gunFreeSchoolsActReportingStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, + "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGunFreeSchoolsActReportingStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "gunFreeSchoolsActReportingStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -142084,7 +176057,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142116,15 +176089,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -142151,7 +176115,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142208,7 +176172,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142437,6 +176401,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_HireStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_HireStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_HireStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_HireStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_HireStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_HireStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -142553,7 +176578,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142596,7 +176621,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142617,6 +176642,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/hireStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getHireStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HireStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "hireStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/hireStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getHireStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HireStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "hireStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/hireStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -142652,7 +176797,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142684,15 +176829,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -142719,7 +176855,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142776,7 +176912,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -143003,6 +177139,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_HiringSourceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_HiringSourceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_HiringSourceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_HiringSourceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_HiringSourceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_HiringSourceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -143119,7 +177316,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143162,7 +177359,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -143183,6 +177380,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/hiringSourceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getHiringSourcesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HiringSourceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "hiringSourceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/hiringSourceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getHiringSourcesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HiringSourceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "hiringSourceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/hiringSourceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -143218,7 +177535,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -143250,15 +177567,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -143285,7 +177593,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143342,7 +177650,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -143569,6 +177877,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -143685,7 +178054,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143728,7 +178097,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -143749,6 +178118,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessPrimaryNighttimeResidencesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "homelessPrimaryNighttimeResidenceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessPrimaryNighttimeResidencesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "homelessPrimaryNighttimeResidenceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -143784,7 +178273,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -143816,15 +178305,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -143851,7 +178331,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143908,7 +178388,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144135,6 +178615,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_HomelessProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_HomelessProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -144251,7 +178792,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144294,7 +178835,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144315,6 +178856,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/homelessProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "homelessProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/homelessProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "homelessProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/homelessProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -144350,7 +179011,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144382,15 +179043,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -144417,7 +179069,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144474,7 +179126,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144701,6 +179353,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IdeaPartDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IdeaPartDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IdeaPartDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -144817,7 +179530,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144860,7 +179573,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144881,6 +179594,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/ideaPartDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIDEAPartsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "ideaPartDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/ideaPartDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIDEAPartsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "ideaPartDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/ideaPartDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -144916,7 +179749,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144948,15 +179781,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -144983,7 +179807,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145040,7 +179864,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145266,6 +180090,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IdentificationDocumentUseDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -145382,7 +180267,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145425,7 +180310,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145445,6 +180330,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/identificationDocumentUseDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIdentificationDocumentUsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "identificationDocumentUseDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/identificationDocumentUseDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIdentificationDocumentUsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "identificationDocumentUseDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/identificationDocumentUseDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -145480,7 +180483,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145512,15 +180515,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -145547,7 +180541,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145604,7 +180598,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145830,6 +180824,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ImmunizationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ImmunizationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ImmunizationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -145946,7 +181001,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145989,7 +181044,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146010,6 +181065,126 @@ "StudentHealth" ] }, + "/ed-fi/immunizationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getImmunizationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "immunizationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentHealth" + ] + }, + "/ed-fi/immunizationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getImmunizationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "immunizationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentHealth" + ] + }, "/ed-fi/immunizationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -146045,7 +181220,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146077,15 +181252,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -146112,7 +181278,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146169,7 +181335,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146396,6 +181562,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IncidentLocationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IncidentLocationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IncidentLocationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -146512,7 +181739,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146555,7 +181782,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146576,6 +181803,126 @@ "Discipline" ] }, + "/ed-fi/incidentLocationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIncidentLocationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "incidentLocationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/incidentLocationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIncidentLocationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "incidentLocationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/incidentLocationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -146611,7 +181958,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146643,15 +181990,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -146678,7 +182016,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146735,7 +182073,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146980,6 +182318,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IndicatorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IndicatorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IndicatorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -147096,7 +182495,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147139,7 +182538,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147178,6 +182577,162 @@ "StudentTranscript" ] }, + "/ed-fi/indicatorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "indicatorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/indicatorDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "indicatorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/indicatorDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -147213,7 +182768,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147245,15 +182800,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -147280,7 +182826,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147337,7 +182883,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147600,6 +183146,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IndicatorGroupDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IndicatorGroupDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IndicatorGroupDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -147716,7 +183323,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147759,7 +183366,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147798,6 +183405,162 @@ "StudentTranscript" ] }, + "/ed-fi/indicatorGroupDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorGroupsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "indicatorGroupDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/indicatorGroupDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorGroupsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "indicatorGroupDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/indicatorGroupDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -147833,7 +183596,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147865,15 +183628,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -147900,7 +183654,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147957,7 +183711,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148220,6 +183974,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IndicatorLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IndicatorLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IndicatorLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -148336,7 +184151,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148379,7 +184194,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148418,6 +184233,162 @@ "StudentTranscript" ] }, + "/ed-fi/indicatorLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "indicatorLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/indicatorLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "indicatorLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/indicatorLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -148453,7 +184424,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148485,15 +184456,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -148520,7 +184482,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148577,7 +184539,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148840,6 +184802,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -148956,7 +184979,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148999,7 +185022,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149038,6 +185061,162 @@ "StudentTranscript" ] }, + "/ed-fi/institutionTelephoneNumberTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInstitutionTelephoneNumberTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "institutionTelephoneNumberTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/institutionTelephoneNumberTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInstitutionTelephoneNumberTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "institutionTelephoneNumberTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/institutionTelephoneNumberTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -149073,7 +185252,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149105,15 +185284,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -149140,7 +185310,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149197,7 +185367,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149442,6 +185612,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InstructionalSettingDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InstructionalSettingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InstructionalSettingDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InstructionalSettingDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InstructionalSettingDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InstructionalSettingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -149558,7 +185789,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149601,7 +185832,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149622,6 +185853,126 @@ "Credential" ] }, + "/ed-fi/instructionalSettingDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInstructionalSettingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InstructionalSettingDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "instructionalSettingDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/instructionalSettingDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInstructionalSettingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InstructionalSettingDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "instructionalSettingDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/instructionalSettingDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -149657,7 +186008,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149689,15 +186040,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -149724,7 +186066,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149781,7 +186123,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150007,6 +186349,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InteractivityStyleDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InteractivityStyleDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InteractivityStyleDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -150123,7 +186526,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150166,7 +186569,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150186,6 +186589,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/interactivityStyleDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInteractivityStylesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "interactivityStyleDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interactivityStyleDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInteractivityStylesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "interactivityStyleDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/interactivityStyleDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -150221,7 +186742,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150253,15 +186774,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -150288,7 +186800,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150345,7 +186857,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150584,6 +187096,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InternetAccessDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InternetAccessDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InternetAccessDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -150700,7 +187273,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150743,7 +187316,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150777,6 +187350,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/internetAccessDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "internetAccessDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/internetAccessDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "internetAccessDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/internetAccessDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -150812,7 +187531,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150844,15 +187563,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -150879,7 +187589,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150936,7 +187646,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151177,6 +187887,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -151293,7 +188064,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151336,7 +188107,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151358,6 +188129,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/internetAccessTypeInResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessTypeInResidencesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "internetAccessTypeInResidenceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/internetAccessTypeInResidenceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessTypeInResidencesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "internetAccessTypeInResidenceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/internetAccessTypeInResidenceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -151393,7 +188286,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151425,15 +188318,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -151460,7 +188344,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151517,7 +188401,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151746,6 +188630,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -151862,7 +188807,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151905,7 +188850,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151927,6 +188872,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/internetPerformanceInResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInternetPerformanceInResidencesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "internetPerformanceInResidenceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/internetPerformanceInResidenceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInternetPerformanceInResidencesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "internetPerformanceInResidenceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/internetPerformanceInResidenceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -151962,7 +189029,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151994,15 +189061,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -152029,7 +189087,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152086,7 +189144,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152315,6 +189373,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InterventionClassDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionClassDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InterventionClassDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -152431,7 +189550,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152474,7 +189593,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152496,6 +189615,128 @@ "StudentCohort" ] }, + "/ed-fi/interventionClassDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionClassesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "interventionClassDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/interventionClassDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionClassesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "interventionClassDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/interventionClassDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -152531,7 +189772,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152563,15 +189804,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -152598,7 +189830,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152655,7 +189887,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152884,6 +190116,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -153000,7 +190293,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153043,7 +190336,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153065,6 +190358,128 @@ "StudentCohort" ] }, + "/ed-fi/interventionEffectivenessRatingDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionEffectivenessRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "interventionEffectivenessRatingDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/interventionEffectivenessRatingDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionEffectivenessRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "interventionEffectivenessRatingDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/interventionEffectivenessRatingDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -153100,7 +190515,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153132,15 +190547,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -153167,7 +190573,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153224,7 +190630,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153938,6 +191344,67 @@ "interventionPrescriptionIdentificationCode" ], "type": "object" + }, + "EdFi_InterventionPrescription_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionPrescription_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionPrescriptionIdentificationCode": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ], + "type": "object" + }, + "EdFi_InterventionPrescription_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -154064,7 +191531,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154107,7 +191574,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154128,6 +191595,126 @@ "Intervention" ] }, + "/ed-fi/interventionPrescriptions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionPrescriptionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "interventionPrescriptions" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/interventionPrescriptions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionPrescriptionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "interventionPrescriptions" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, "/ed-fi/interventionPrescriptions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -154163,7 +191750,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154195,15 +191782,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -154230,7 +191808,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154287,7 +191865,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -155157,6 +192735,67 @@ "stateAbbreviationDescriptor" ], "type": "object" + }, + "EdFi_InterventionStudy_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionStudy_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionStudyIdentificationCode": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionStudyIdentificationCode" + ], + "type": "object" + }, + "EdFi_InterventionStudy_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -155284,7 +192923,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155327,7 +192966,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -155348,6 +192987,126 @@ "Intervention" ] }, + "/ed-fi/interventionStudies/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionStudiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "interventionStudies" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/interventionStudies/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionStudiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "interventionStudies" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, "/ed-fi/interventionStudies/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -155383,7 +193142,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -155415,15 +193174,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -155450,7 +193200,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155507,7 +193257,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156484,6 +194234,67 @@ "staffReference" ], "type": "object" + }, + "EdFi_Intervention_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Intervention_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionIdentificationCode": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionIdentificationCode" + ], + "type": "object" + }, + "EdFi_Intervention_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -156628,7 +194439,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156671,7 +194482,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156693,6 +194504,128 @@ "StudentCohort" ] }, + "/ed-fi/interventions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "interventions" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/interventions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "interventions" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/interventions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -156728,7 +194661,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156760,15 +194693,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -156795,7 +194719,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156852,7 +194776,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157127,6 +195051,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LanguageDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LanguageDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LanguageDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -157243,7 +195228,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157286,7 +195271,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157328,6 +195313,168 @@ "StudentAssessment" ] }, + "/ed-fi/languageDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLanguagesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "languageDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Intervention", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment" + ] + }, + "/ed-fi/languageDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLanguagesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "languageDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Intervention", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment" + ] + }, "/ed-fi/languageDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -157363,7 +195510,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157395,15 +195542,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -157430,7 +195568,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157487,7 +195625,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157735,6 +195873,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -157851,7 +196050,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157894,7 +196093,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157915,6 +196114,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/languageInstructionProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageInstructionProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "languageInstructionProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/languageInstructionProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageInstructionProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "languageInstructionProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/languageInstructionProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -157950,7 +196269,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157982,15 +196301,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -158017,7 +196327,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158074,7 +196384,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158315,6 +196625,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LanguageUseDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LanguageUseDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LanguageUseDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -158431,7 +196802,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158474,7 +196845,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158509,6 +196880,154 @@ "SectionsAndPrograms" ] }, + "/ed-fi/languageUseDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageUsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "languageUseDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Intervention", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/languageUseDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageUsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "languageUseDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Intervention", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/languageUseDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -158544,7 +197063,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158576,15 +197095,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -158611,7 +197121,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158668,7 +197178,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158915,6 +197425,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LearningStandardCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LearningStandardCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -159031,7 +197602,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159074,7 +197645,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159101,6 +197672,138 @@ "Standards" ] }, + "/ed-fi/learningStandardCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "learningStandardCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, + "/ed-fi/learningStandardCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "learningStandardCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, "/ed-fi/learningStandardCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -159136,7 +197839,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159168,15 +197871,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -159203,7 +197897,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159260,7 +197954,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159595,6 +198289,73 @@ "targetLearningStandardId" ], "type": "object" + }, + "EdFi_LearningStandardEquivalenceAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "sourceLearningStandardId": { + "maxLength": 60, + "type": "string" + }, + "targetLearningStandardId": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "namespace", + "sourceLearningStandardId", + "targetLearningStandardId" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -159713,7 +198474,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159756,7 +198517,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159777,6 +198538,126 @@ "Assessment" ] }, + "/ed-fi/learningStandardEquivalenceAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "learningStandardEquivalenceAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, + "/ed-fi/learningStandardEquivalenceAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "learningStandardEquivalenceAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, "/ed-fi/learningStandardEquivalenceAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -159812,7 +198693,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159844,15 +198725,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -159879,7 +198751,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159936,7 +198808,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -160169,6 +199041,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -160285,7 +199218,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -160328,7 +199261,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -160349,6 +199282,126 @@ "Assessment" ] }, + "/ed-fi/learningStandardEquivalenceStrengthDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceStrengthsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "learningStandardEquivalenceStrengthDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, + "/ed-fi/learningStandardEquivalenceStrengthDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceStrengthsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "learningStandardEquivalenceStrengthDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, "/ed-fi/learningStandardEquivalenceStrengthDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -160384,7 +199437,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -160416,15 +199469,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -160451,7 +199495,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -160508,7 +199552,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -160741,6 +199785,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LearningStandardScopeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardScopeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LearningStandardScopeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -160857,7 +199962,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -160900,7 +200005,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -160927,6 +200032,138 @@ "Standards" ] }, + "/ed-fi/learningStandardScopeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardScopesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "learningStandardScopeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, + "/ed-fi/learningStandardScopeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardScopesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "learningStandardScopeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, "/ed-fi/learningStandardScopeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -160962,7 +200199,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -160994,15 +200231,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -161029,7 +200257,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -161086,7 +200314,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -161915,6 +201143,62 @@ "learningStandardId" ], "type": "object" + }, + "EdFi_LearningStandard_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandard_TrackedChangeKey": { + "properties": { + "learningStandardId": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "learningStandardId" + ], + "type": "object" + }, + "EdFi_LearningStandard_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -162069,7 +201353,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162112,7 +201396,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162139,6 +201423,138 @@ "Standards" ] }, + "/ed-fi/learningStandards/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "learningStandards" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, + "/ed-fi/learningStandards/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "learningStandards" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, "/ed-fi/learningStandards/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -162174,7 +201590,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162206,15 +201622,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -162241,7 +201648,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162298,7 +201705,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162562,6 +201969,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LengthOfContractDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LengthOfContractDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LengthOfContractDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LengthOfContractDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LengthOfContractDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LengthOfContractDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -162678,7 +202146,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162721,7 +202189,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162742,6 +202210,126 @@ "Staff" ] }, + "/ed-fi/lengthOfContractDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLengthOfContractsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LengthOfContractDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "lengthOfContractDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/lengthOfContractDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLengthOfContractsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LengthOfContractDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "lengthOfContractDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/lengthOfContractDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -162777,7 +202365,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162809,15 +202397,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -162844,7 +202423,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162901,7 +202480,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163140,6 +202719,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LevelOfEducationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LevelOfEducationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LevelOfEducationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -163256,7 +202896,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163299,7 +202939,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163332,6 +202972,150 @@ "SectionsAndPrograms" ] }, + "/ed-fi/levelOfEducationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLevelOfEducationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "levelOfEducationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Intervention", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/levelOfEducationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLevelOfEducationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "levelOfEducationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Intervention", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/levelOfEducationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -163367,7 +203151,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163399,15 +203183,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -163434,7 +203209,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163491,7 +203266,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163730,6 +203505,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LicenseStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LicenseStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LicenseStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -163846,7 +203682,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163889,7 +203725,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163910,6 +203746,126 @@ "EducationOrganization" ] }, + "/ed-fi/licenseStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "licenseStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/licenseStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "licenseStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/licenseStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -163945,7 +203901,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163977,15 +203933,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -164012,7 +203959,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164069,7 +204016,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164296,6 +204243,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LicenseTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LicenseTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LicenseTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -164412,7 +204420,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164455,7 +204463,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164476,6 +204484,126 @@ "EducationOrganization" ] }, + "/ed-fi/licenseTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "licenseTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/licenseTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "licenseTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/licenseTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -164511,7 +204639,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164543,15 +204671,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -164578,7 +204697,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164635,7 +204754,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164864,6 +204983,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -164980,7 +205160,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165023,7 +205203,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165046,6 +205226,130 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/limitedEnglishProficiencyDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLimitedEnglishProficienciesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "limitedEnglishProficiencyDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/limitedEnglishProficiencyDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLimitedEnglishProficienciesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "limitedEnglishProficiencyDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/limitedEnglishProficiencyDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -165081,7 +205385,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165113,15 +205417,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -165148,7 +205443,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165205,7 +205500,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165622,6 +205917,72 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_LocalAccount_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalAccount_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalAccount_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -165741,7 +206102,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165784,7 +206145,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165805,6 +206166,126 @@ "Finance" ] }, + "/ed-fi/localAccounts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalAccountsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localAccounts" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localAccounts/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalAccountsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localAccounts" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/localAccounts/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -165840,7 +206321,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165872,15 +206353,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -165907,7 +206379,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165964,7 +206436,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166285,6 +206757,77 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_LocalActual_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalActual_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalActual_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -166403,7 +206946,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166446,7 +206989,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166467,6 +207010,126 @@ "Finance" ] }, + "/ed-fi/localActuals/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalActualsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localActuals" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localActuals/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalActualsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localActuals" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/localActuals/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -166502,7 +207165,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166534,15 +207197,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -166569,7 +207223,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166626,7 +207280,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166942,6 +207596,77 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_LocalBudget_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalBudget_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalBudget_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -167060,7 +207785,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -167103,7 +207828,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -167124,6 +207849,126 @@ "Finance" ] }, + "/ed-fi/localBudgets/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalBudgetsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localBudgets" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localBudgets/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalBudgetsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localBudgets" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/localBudgets/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -167159,7 +208004,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -167191,15 +208036,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -167226,7 +208062,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -167283,7 +208119,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -167643,6 +208479,82 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_LocalContractedStaff_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalContractedStaff_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_LocalContractedStaff_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -167771,7 +208683,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -167814,7 +208726,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -167835,6 +208747,126 @@ "Finance" ] }, + "/ed-fi/localContractedStaffs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalContractedStaffsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localContractedStaffs" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localContractedStaffs/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalContractedStaffsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localContractedStaffs" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/localContractedStaffs/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -167870,7 +208902,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -167902,15 +208934,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -167937,7 +208960,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -167994,7 +209017,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169709,6 +210732,62 @@ "localEducationAgencyId" ], "type": "object" + }, + "EdFi_LocalEducationAgency_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalEducationAgency_TrackedChangeKey": { + "properties": { + "localEducationAgencyId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "localEducationAgencyId" + ], + "type": "object" + }, + "EdFi_LocalEducationAgency_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -169873,7 +210952,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169916,7 +210995,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169939,6 +211018,130 @@ "Staff" ] }, + "/ed-fi/localEducationAgencies/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgenciesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localEducationAgencies" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, + "/ed-fi/localEducationAgencies/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgenciesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localEducationAgencies" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, "/ed-fi/localEducationAgencies/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -169974,7 +211177,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -170006,15 +211209,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -170041,7 +211235,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170098,7 +211292,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -170375,6 +211569,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -170491,7 +211746,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170534,7 +211789,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -170557,6 +211812,130 @@ "Staff" ] }, + "/ed-fi/localEducationAgencyCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgencyCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localEducationAgencyCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, + "/ed-fi/localEducationAgencyCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgencyCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localEducationAgencyCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, "/ed-fi/localEducationAgencyCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -170592,7 +211971,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -170624,15 +212003,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -170659,7 +212029,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170716,7 +212086,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -171031,6 +212401,77 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_LocalEncumbrance_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalEncumbrance_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalEncumbrance_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -171149,7 +212590,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -171192,7 +212633,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -171213,6 +212654,126 @@ "Finance" ] }, + "/ed-fi/localEncumbrances/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEncumbrancesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localEncumbrances" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localEncumbrances/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEncumbrancesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localEncumbrances" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/localEncumbrances/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -171248,7 +212809,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -171280,15 +212841,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -171315,7 +212867,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -171372,7 +212924,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -171732,6 +213284,82 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_LocalPayroll_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalPayroll_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_LocalPayroll_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -171860,7 +213488,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -171903,7 +213531,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -171924,6 +213552,126 @@ "Finance" ] }, + "/ed-fi/localPayrolls/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalPayrollsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localPayrolls" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localPayrolls/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalPayrollsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localPayrolls" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/localPayrolls/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -171959,7 +213707,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -171991,15 +213739,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -172026,7 +213765,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172083,7 +213822,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172343,6 +214082,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LocaleDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocaleDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LocaleDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -172459,7 +214259,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172502,7 +214302,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172546,6 +214346,172 @@ "StudentTranscript" ] }, + "/ed-fi/localeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/localeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/localeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -172581,7 +214547,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172613,15 +214579,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -172648,7 +214605,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172705,7 +214662,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172991,6 +214948,67 @@ "schoolId" ], "type": "object" + }, + "EdFi_Location_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Location_TrackedChangeKey": { + "properties": { + "classroomIdentificationCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "classroomIdentificationCode", + "schoolId" + ], + "type": "object" + }, + "EdFi_Location_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -173089,7 +215107,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173132,7 +215150,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173154,6 +215172,128 @@ "SectionsAndPrograms" ] }, + "/ed-fi/locations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "locations" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/locations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "locations" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/locations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -173189,7 +215329,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173221,15 +215361,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -173256,7 +215387,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173313,7 +215444,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173546,6 +215677,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -173662,7 +215854,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173705,7 +215897,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173739,6 +215931,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMagnetSpecialProgramEmphasisSchoolsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "magnetSpecialProgramEmphasisSchoolDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMagnetSpecialProgramEmphasisSchoolsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "magnetSpecialProgramEmphasisSchoolDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -173774,7 +216112,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173806,15 +216144,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -173841,7 +216170,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173898,7 +216227,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -174152,6 +216481,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MediumOfInstructionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MediumOfInstructionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MediumOfInstructionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -174268,7 +216658,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -174311,7 +216701,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -174346,6 +216736,154 @@ "SectionsAndPrograms" ] }, + "/ed-fi/mediumOfInstructionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMediumOfInstructionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "mediumOfInstructionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "EducationOrganization", + "Graduation", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/mediumOfInstructionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMediumOfInstructionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "mediumOfInstructionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "EducationOrganization", + "Graduation", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/mediumOfInstructionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -174381,7 +216919,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -174413,15 +216951,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -174448,7 +216977,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -174505,7 +217034,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -174749,6 +217278,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MethodCreditEarnedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MethodCreditEarnedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -174865,7 +217455,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -174908,7 +217498,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -174932,6 +217522,132 @@ "StudentTranscript" ] }, + "/ed-fi/methodCreditEarnedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMethodCreditEarnedsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "methodCreditEarnedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/methodCreditEarnedDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMethodCreditEarnedsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "methodCreditEarnedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/methodCreditEarnedDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -174967,7 +217683,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -174999,15 +217715,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -175034,7 +217741,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175091,7 +217798,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -175321,6 +218028,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -175437,7 +218205,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175480,7 +218248,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -175501,6 +218269,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/migrantEducationProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMigrantEducationProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "migrantEducationProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/migrantEducationProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMigrantEducationProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "migrantEducationProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/migrantEducationProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -175536,7 +218424,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -175568,15 +218456,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -175603,7 +218482,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175660,7 +218539,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -175887,6 +218766,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ModelEntityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ModelEntityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ModelEntityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -176003,7 +218943,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176046,7 +218986,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176067,6 +219007,126 @@ "EducationOrganization" ] }, + "/ed-fi/modelEntityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getModelEntitiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "modelEntityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/modelEntityDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getModelEntitiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "modelEntityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/modelEntityDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -176102,7 +219162,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176134,15 +219194,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -176169,7 +219220,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176226,7 +219277,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176453,6 +219504,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MonitoredDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MonitoredDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MonitoredDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -176569,7 +219681,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176612,7 +219724,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176633,6 +219745,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/monitoredDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMonitoredsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "monitoredDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/monitoredDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMonitoredsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "monitoredDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/monitoredDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -176668,7 +219900,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176700,15 +219932,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -176735,7 +219958,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176792,7 +220015,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177019,6 +220242,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -177135,7 +220419,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177178,7 +220462,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177199,6 +220483,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/neglectedOrDelinquentProgramDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "neglectedOrDelinquentProgramDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/neglectedOrDelinquentProgramDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "neglectedOrDelinquentProgramDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/neglectedOrDelinquentProgramDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -177234,7 +220638,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177266,15 +220670,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -177301,7 +220696,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177358,7 +220753,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177585,6 +220980,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -177701,7 +221157,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177744,7 +221200,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177765,6 +221221,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "neglectedOrDelinquentProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "neglectedOrDelinquentProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -177800,7 +221376,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177832,15 +221408,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -177867,7 +221434,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177924,7 +221491,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178151,6 +221718,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NetworkPurposeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NetworkPurposeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NetworkPurposeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -178267,7 +221895,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178310,7 +221938,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178331,6 +221959,126 @@ "EducationOrganization" ] }, + "/ed-fi/networkPurposeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNetworkPurposesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "networkPurposeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/networkPurposeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNetworkPurposesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "networkPurposeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/networkPurposeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -178366,7 +222114,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178398,15 +222146,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -178433,7 +222172,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178490,7 +222229,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178717,6 +222456,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -178833,7 +222633,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178876,7 +222676,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178897,6 +222697,126 @@ "StudentHealth" ] }, + "/ed-fi/nonMedicalImmunizationExemptionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNonMedicalImmunizationExemptionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "nonMedicalImmunizationExemptionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentHealth" + ] + }, + "/ed-fi/nonMedicalImmunizationExemptionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNonMedicalImmunizationExemptionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "nonMedicalImmunizationExemptionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentHealth" + ] + }, "/ed-fi/nonMedicalImmunizationExemptionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -178932,7 +222852,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178964,15 +222884,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -178999,7 +222910,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179056,7 +222967,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179344,6 +223255,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ObjectDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ObjectDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ObjectDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -179433,7 +223405,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179476,7 +223448,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179497,6 +223469,126 @@ "Finance" ] }, + "/ed-fi/objectDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getObjectDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "objectDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/objectDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getObjectDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "objectDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/objectDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -179532,7 +223624,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179564,15 +223656,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -179599,7 +223682,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179656,7 +223739,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180507,6 +224590,73 @@ "identificationCode" ], "type": "object" + }, + "EdFi_ObjectiveAssessment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ObjectiveAssessment_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "identificationCode": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "identificationCode", + "namespace" + ], + "type": "object" + }, + "EdFi_ObjectiveAssessment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -180643,7 +224793,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180686,7 +224836,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180708,6 +224858,128 @@ "AssessmentMetadata" ] }, + "/ed-fi/objectiveAssessments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getObjectiveAssessmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "objectiveAssessments" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/objectiveAssessments/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getObjectiveAssessmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "objectiveAssessments" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, "/ed-fi/objectiveAssessments/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -180743,7 +225015,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180775,15 +225047,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -180810,7 +225073,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180867,7 +225130,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181117,6 +225380,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ObjectiveRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ObjectiveRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ObjectiveRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -181233,7 +225557,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181276,7 +225600,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181297,6 +225621,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/objectiveRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getObjectiveRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectiveRatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "objectiveRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/objectiveRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getObjectiveRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectiveRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "objectiveRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/objectiveRatingLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -181332,7 +225776,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181364,15 +225808,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -181399,7 +225834,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181456,7 +225891,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181683,6 +226118,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_OpenStaffPositionEventStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OpenStaffPositionEventStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_OpenStaffPositionEventStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -181799,7 +226295,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181842,7 +226338,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181863,6 +226359,126 @@ "Staff" ] }, + "/ed-fi/openStaffPositionEventStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionEventStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "openStaffPositionEventStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/openStaffPositionEventStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionEventStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "openStaffPositionEventStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/openStaffPositionEventStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -181898,7 +226514,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181930,15 +226546,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -181965,7 +226572,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182022,7 +226629,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -182249,6 +226856,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_OpenStaffPositionEventTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OpenStaffPositionEventTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_OpenStaffPositionEventTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -182365,7 +227033,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182408,7 +227076,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -182429,6 +227097,126 @@ "Staff" ] }, + "/ed-fi/openStaffPositionEventTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionEventTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "openStaffPositionEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/openStaffPositionEventTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionEventTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "openStaffPositionEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/openStaffPositionEventTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -182464,7 +227252,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -182496,15 +227284,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -182531,7 +227310,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182588,7 +227367,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -182884,6 +227663,77 @@ "openStaffPositionEventTypeDescriptor" ], "type": "object" + }, + "EdFi_OpenStaffPositionEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OpenStaffPositionEvent_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "openStaffPositionEventTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "requisitionNumber": { + "maxLength": 20, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "eventDate", + "openStaffPositionEventTypeDescriptor", + "requisitionNumber" + ], + "type": "object" + }, + "EdFi_OpenStaffPositionEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -182993,7 +227843,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183036,7 +227886,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183057,6 +227907,126 @@ "Staff" ] }, + "/ed-fi/openStaffPositionEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "openStaffPositionEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/openStaffPositionEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "openStaffPositionEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/openStaffPositionEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -183092,7 +228062,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183124,15 +228094,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -183159,7 +228120,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183216,7 +228177,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183440,6 +228401,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_OpenStaffPositionReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OpenStaffPositionReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_OpenStaffPositionReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -183556,7 +228578,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183599,7 +228621,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183620,6 +228642,126 @@ "Staff" ] }, + "/ed-fi/openStaffPositionReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "openStaffPositionReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/openStaffPositionReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "openStaffPositionReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/openStaffPositionReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -183655,7 +228797,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183687,15 +228829,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -183722,7 +228855,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183779,7 +228912,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -184500,6 +229633,67 @@ "requisitionNumber" ], "type": "object" + }, + "EdFi_OpenStaffPosition_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OpenStaffPosition_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "requisitionNumber": { + "maxLength": 20, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "requisitionNumber" + ], + "type": "object" + }, + "EdFi_OpenStaffPosition_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -184741,7 +229935,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184784,7 +229978,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -184805,6 +229999,126 @@ "Staff" ] }, + "/ed-fi/openStaffPositions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "openStaffPositions" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/openStaffPositions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "openStaffPositions" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/openStaffPositions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -184840,7 +230154,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -184872,15 +230186,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -184907,7 +230212,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184964,7 +230269,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -185296,6 +230601,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_OperationalStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OperationalStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_OperationalStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -185412,7 +230778,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -185455,7 +230821,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -185494,6 +230860,162 @@ "StudentTranscript" ] }, + "/ed-fi/operationalStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "operationalStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/operationalStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "operationalStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/operationalStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -185529,7 +231051,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -185561,15 +231083,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -185596,7 +231109,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -185653,7 +231166,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -185959,6 +231472,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_OperationalUnitDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OperationalUnitDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_OperationalUnitDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -186048,7 +231622,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -186091,7 +231665,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -186112,6 +231686,126 @@ "Finance" ] }, + "/ed-fi/operationalUnitDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalUnitDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "operationalUnitDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/operationalUnitDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalUnitDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "operationalUnitDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/operationalUnitDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -186147,7 +231841,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -186179,15 +231873,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -186214,7 +231899,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -186271,7 +231956,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -187496,6 +233181,62 @@ "organizationDepartmentId" ], "type": "object" + }, + "EdFi_OrganizationDepartment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OrganizationDepartment_TrackedChangeKey": { + "properties": { + "organizationDepartmentId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "organizationDepartmentId" + ], + "type": "object" + }, + "EdFi_OrganizationDepartment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -187622,7 +233363,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -187665,7 +233406,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -187686,6 +233427,126 @@ "EducationOrganization" ] }, + "/ed-fi/organizationDepartments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOrganizationDepartmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "organizationDepartments" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/organizationDepartments/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOrganizationDepartmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "organizationDepartments" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/organizationDepartments/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -187721,7 +233582,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -187753,15 +233614,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -187788,7 +233640,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -187845,7 +233697,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188114,6 +233966,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_OtherNameTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OtherNameTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_OtherNameTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -188230,7 +234143,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188273,7 +234186,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188316,6 +234229,170 @@ "StudentTranscript" ] }, + "/ed-fi/otherNameTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOtherNameTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "otherNameTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/otherNameTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOtherNameTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "otherNameTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/otherNameTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -188351,7 +234428,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188383,15 +234460,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -188418,7 +234486,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188475,7 +234543,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188724,6 +234792,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ParticipationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ParticipationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ParticipationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -188840,7 +234969,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188883,7 +235012,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188904,6 +235033,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/participationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "participationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/participationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "participationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/participationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -188939,7 +235188,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188971,15 +235220,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -189006,7 +235246,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -189063,7 +235303,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -189290,6 +235530,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ParticipationStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ParticipationStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ParticipationStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -189406,7 +235707,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -189449,7 +235750,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -189470,6 +235771,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/participationStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "participationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/participationStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "participationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/participationStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -189505,7 +235926,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -189537,15 +235958,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -189572,7 +235984,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -189629,7 +236041,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -189856,6 +236268,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PathMilestoneStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestoneStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PathMilestoneStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PathMilestoneStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestoneStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestoneStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -189972,7 +236445,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190015,7 +236488,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -190036,6 +236509,126 @@ "Path" ] }, + "/ed-fi/pathMilestoneStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPathMilestoneStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathMilestoneStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "pathMilestoneStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/pathMilestoneStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPathMilestoneStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathMilestoneStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "pathMilestoneStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/pathMilestoneStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -190071,7 +236664,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -190103,15 +236696,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -190138,7 +236722,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190195,7 +236779,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -190422,6 +237006,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PathMilestoneTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestoneTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PathMilestoneTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PathMilestoneTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestoneTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestoneTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -190538,7 +237183,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190581,7 +237226,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -190602,6 +237247,126 @@ "Path" ] }, + "/ed-fi/pathMilestoneTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPathMilestoneTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathMilestoneTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "pathMilestoneTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/pathMilestoneTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPathMilestoneTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathMilestoneTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "pathMilestoneTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/pathMilestoneTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -190637,7 +237402,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -190669,15 +237434,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -190704,7 +237460,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190761,7 +237517,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191013,6 +237769,68 @@ "pathMilestoneTypeDescriptor" ], "type": "object" + }, + "EdFi_PathMilestone_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestone_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PathMilestone_TrackedChangeKey": { + "properties": { + "pathMilestoneName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + }, + "pathMilestoneTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "pathMilestoneName", + "pathMilestoneTypeDescriptor" + ], + "type": "object" + }, + "EdFi_PathMilestone_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestone_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestone_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -191113,7 +237931,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191156,7 +237974,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191177,6 +237995,126 @@ "Path" ] }, + "/ed-fi/pathMilestones/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPathMilestonesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathMilestone_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "pathMilestones" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/pathMilestones/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPathMilestonesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathMilestone_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "pathMilestones" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/pathMilestones/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -191212,7 +238150,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191244,15 +238182,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -191279,7 +238208,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191336,7 +238265,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191550,6 +238479,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PathPhaseStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PathPhaseStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PathPhaseStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PathPhaseStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PathPhaseStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PathPhaseStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -191666,7 +238656,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191709,7 +238699,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191730,6 +238720,126 @@ "Path" ] }, + "/ed-fi/pathPhaseStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPathPhaseStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathPhaseStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "pathPhaseStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/pathPhaseStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPathPhaseStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathPhaseStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "pathPhaseStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/pathPhaseStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -191765,7 +238875,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191797,15 +238907,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -191832,7 +238933,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191889,7 +238990,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -192250,6 +239351,74 @@ "pathPhaseName" ], "type": "object" + }, + "EdFi_PathPhase_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PathPhase_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PathPhase_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "pathName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + }, + "pathPhaseName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "pathName", + "pathPhaseName" + ], + "type": "object" + }, + "EdFi_PathPhase_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PathPhase_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PathPhase_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -192360,7 +239529,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -192403,7 +239572,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -192424,6 +239593,126 @@ "Path" ] }, + "/ed-fi/pathPhases/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPathPhasesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathPhase_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "pathPhases" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/pathPhases/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPathPhasesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathPhase_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "pathPhases" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/pathPhases/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -192459,7 +239748,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -192491,15 +239780,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -192526,7 +239806,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -192583,7 +239863,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -192869,6 +240149,68 @@ "pathName" ], "type": "object" + }, + "EdFi_Path_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Path_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Path_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "pathName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "pathName" + ], + "type": "object" + }, + "EdFi_Path_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Path_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Path_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -192970,7 +240312,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -193013,7 +240355,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -193034,6 +240376,126 @@ "Path" ] }, + "/ed-fi/paths/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPathsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Path_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "paths" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/paths/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPathsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Path_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "paths" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/paths/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -193069,7 +240531,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -193101,15 +240563,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -193136,7 +240589,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -193193,7 +240646,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -193396,6 +240849,67 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "EdFi_Person_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Person_TrackedChangeKey": { + "properties": { + "personId": { + "maxLength": 32, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "personId", + "sourceSystemDescriptor" + ], + "type": "object" + }, + "EdFi_Person_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -193476,7 +240990,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -193519,7 +241033,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -193541,6 +241055,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/people/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPeopleDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "people" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/people/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPeopleKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "people" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/people/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -193576,7 +241212,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -193608,15 +241244,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -193643,7 +241270,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -193700,7 +241327,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -193904,6 +241531,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PerformanceBaseConversionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -194020,7 +241708,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194063,7 +241751,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -194085,6 +241773,128 @@ "ReportCard" ] }, + "/ed-fi/performanceBaseConversionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceBaseConversionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceBaseConversionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/performanceBaseConversionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceBaseConversionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "performanceBaseConversionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, "/ed-fi/performanceBaseConversionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -194120,7 +241930,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -194152,15 +241962,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -194187,7 +241988,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194244,7 +242045,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -194472,6 +242273,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -194588,7 +242450,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194631,7 +242493,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -194652,6 +242514,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/performanceEvaluationRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceEvaluationRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceEvaluationRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/performanceEvaluationRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceEvaluationRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "performanceEvaluationRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/performanceEvaluationRatingLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -194687,7 +242669,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -194719,15 +242701,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -194754,7 +242727,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194811,7 +242784,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -195600,6 +243573,98 @@ "lastSurname" ], "type": "object" + }, + "EdFi_PerformanceEvaluationRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceEvaluationRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationPeriodDescriptor", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_PerformanceEvaluationRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -195812,7 +243877,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -195855,7 +243920,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -195876,6 +243941,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/performanceEvaluationRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceEvaluationRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceEvaluationRatings" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/performanceEvaluationRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceEvaluationRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "performanceEvaluationRatings" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/performanceEvaluationRatings/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -195911,7 +244096,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -195943,15 +244128,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -195978,7 +244154,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -196035,7 +244211,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -196333,6 +244509,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PerformanceEvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceEvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PerformanceEvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -196449,7 +244686,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -196492,7 +244729,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -196513,6 +244750,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/performanceEvaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceEvaluationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceEvaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/performanceEvaluationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceEvaluationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "performanceEvaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/performanceEvaluationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -196548,7 +244905,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -196580,15 +244937,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -196615,7 +244963,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -196672,7 +245020,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -197234,6 +245582,88 @@ "termDescriptor" ], "type": "object" + }, + "EdFi_PerformanceEvaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceEvaluation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationPeriodDescriptor", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_PerformanceEvaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -197373,7 +245803,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -197416,7 +245846,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -197437,6 +245867,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/performanceEvaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceEvaluationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceEvaluations" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/performanceEvaluations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceEvaluationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "performanceEvaluations" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/performanceEvaluations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -197472,7 +246022,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -197504,15 +246054,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -197539,7 +246080,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -197596,7 +246137,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -197847,6 +246388,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PerformanceLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PerformanceLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -197963,7 +246565,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198006,7 +246608,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198029,6 +246631,130 @@ "StudentAssessment" ] }, + "/ed-fi/performanceLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata", + "StudentAssessment" + ] + }, + "/ed-fi/performanceLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "performanceLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata", + "StudentAssessment" + ] + }, "/ed-fi/performanceLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -198064,7 +246790,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198096,15 +246822,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -198131,7 +246848,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198188,7 +246905,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198416,6 +247133,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PersonalInformationVerificationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -198532,7 +247310,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198575,7 +247353,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198595,6 +247373,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/personalInformationVerificationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPersonalInformationVerificationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "personalInformationVerificationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/personalInformationVerificationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPersonalInformationVerificationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "personalInformationVerificationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/personalInformationVerificationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -198630,7 +247526,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198662,15 +247558,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -198697,7 +247584,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198754,7 +247641,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198983,6 +247870,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PlatformTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PlatformTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PlatformTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -199099,7 +248047,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199142,7 +248090,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -199166,6 +248114,132 @@ "StudentAssessment" ] }, + "/ed-fi/platformTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPlatformTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "platformTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentRegistration", + "AssessmentMetadata", + "StudentAssessment" + ] + }, + "/ed-fi/platformTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPlatformTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "platformTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentRegistration", + "AssessmentMetadata", + "StudentAssessment" + ] + }, "/ed-fi/platformTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -199201,7 +248275,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -199233,15 +248307,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -199268,7 +248333,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199325,7 +248390,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -199569,6 +248634,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PopulationServedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PopulationServedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PopulationServedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -199685,7 +248811,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199728,7 +248854,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -199763,6 +248889,154 @@ "SectionsAndPrograms" ] }, + "/ed-fi/populationServedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPopulationServedsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "populationServedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Credential", + "Intervention", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/populationServedDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPopulationServedsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "populationServedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Credential", + "Intervention", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/populationServedDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -199798,7 +249072,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -199830,15 +249104,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -199865,7 +249130,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199922,7 +249187,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200163,6 +249428,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -200279,7 +249605,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200322,7 +249648,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200343,6 +249669,126 @@ "Graduation" ] }, + "/ed-fi/postSecondaryEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "postSecondaryEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation" + ] + }, + "/ed-fi/postSecondaryEventCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "postSecondaryEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation" + ] + }, "/ed-fi/postSecondaryEventCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -200378,7 +249824,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200410,15 +249856,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -200445,7 +249882,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200502,7 +249939,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200791,6 +250228,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_PostSecondaryEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryEvent_TrackedChangeKey": { + "properties": { + "eventDate": { + "format": "date", + "type": "string" + }, + "postSecondaryEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "eventDate", + "postSecondaryEventCategoryDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_PostSecondaryEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -200891,7 +250394,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200934,7 +250437,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200955,6 +250458,126 @@ "Graduation" ] }, + "/ed-fi/postSecondaryEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "postSecondaryEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation" + ] + }, + "/ed-fi/postSecondaryEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "postSecondaryEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation" + ] + }, "/ed-fi/postSecondaryEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -200990,7 +250613,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -201022,15 +250645,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -201057,7 +250671,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -201114,7 +250728,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -201330,6 +250944,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -201446,7 +251121,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -201489,7 +251164,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -201511,6 +251186,128 @@ "Graduation" ] }, + "/ed-fi/postSecondaryInstitutionLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "postSecondaryInstitutionLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Graduation" + ] + }, + "/ed-fi/postSecondaryInstitutionLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "postSecondaryInstitutionLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Graduation" + ] + }, "/ed-fi/postSecondaryInstitutionLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -201546,7 +251343,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -201578,15 +251375,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -201613,7 +251401,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -201670,7 +251458,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -202979,6 +252767,62 @@ "postSecondaryInstitutionId" ], "type": "object" + }, + "EdFi_PostSecondaryInstitution_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitution_TrackedChangeKey": { + "properties": { + "postSecondaryInstitutionId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "postSecondaryInstitutionId" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitution_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -203113,7 +252957,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -203156,7 +253000,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -203178,6 +253022,128 @@ "Graduation" ] }, + "/ed-fi/postSecondaryInstitutions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "postSecondaryInstitutions" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Graduation" + ] + }, + "/ed-fi/postSecondaryInstitutions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "postSecondaryInstitutions" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Graduation" + ] + }, "/ed-fi/postSecondaryInstitutions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -203213,7 +253179,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -203245,15 +253211,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -203280,7 +253237,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -203337,7 +253294,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -203590,6 +253547,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PostingResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostingResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PostingResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -203706,7 +253724,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -203749,7 +253767,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -203770,6 +253788,126 @@ "Staff" ] }, + "/ed-fi/postingResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostingResultsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "postingResultDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/postingResultDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostingResultsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "postingResultDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/postingResultDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -203805,7 +253943,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -203837,15 +253975,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -203872,7 +254001,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -203929,7 +254058,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -204156,6 +254285,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PreviousCareerDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PreviousCareerDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PreviousCareerDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PreviousCareerDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PreviousCareerDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PreviousCareerDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -204272,7 +254462,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204315,7 +254505,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -204336,6 +254526,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/previousCareerDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPreviousCareersDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PreviousCareerDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "previousCareerDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/previousCareerDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPreviousCareersKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PreviousCareerDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "previousCareerDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/previousCareerDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -204371,7 +254681,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -204403,15 +254713,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -204438,7 +254739,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204495,7 +254796,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -204723,6 +255024,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -204839,7 +255201,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204882,7 +255244,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -204904,6 +255266,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/primaryLearningDeviceAccessDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAccessesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "primaryLearningDeviceAccessDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/primaryLearningDeviceAccessDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAccessesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "primaryLearningDeviceAccessDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/primaryLearningDeviceAccessDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -204939,7 +255423,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -204971,15 +255455,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -205006,7 +255481,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205063,7 +255538,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -205292,6 +255767,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -205408,7 +255944,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205451,7 +255987,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -205473,6 +256009,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAwayFromSchoolsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "primaryLearningDeviceAwayFromSchoolDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAwayFromSchoolsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "primaryLearningDeviceAwayFromSchoolDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -205508,7 +256166,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -205540,15 +256198,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -205575,7 +256224,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205632,7 +256281,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -205861,6 +256510,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -205977,7 +256687,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206020,7 +256730,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206042,6 +256752,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/primaryLearningDeviceProviderDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceProvidersDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "primaryLearningDeviceProviderDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/primaryLearningDeviceProviderDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceProvidersKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "primaryLearningDeviceProviderDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/primaryLearningDeviceProviderDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -206077,7 +256909,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206109,15 +256941,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -206144,7 +256967,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206201,7 +257024,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206553,6 +257376,84 @@ "professionalDevelopmentTitle" ], "type": "object" + }, + "EdFi_ProfessionalDevelopmentEventAttendance_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEventAttendance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProfessionalDevelopmentEventAttendance_TrackedChangeKey": { + "properties": { + "attendanceDate": { + "format": "date", + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "professionalDevelopmentTitle": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "attendanceDate", + "namespace", + "personId", + "professionalDevelopmentTitle", + "sourceSystemDescriptor" + ], + "type": "object" + }, + "EdFi_ProfessionalDevelopmentEventAttendance_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEventAttendance_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEventAttendance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -206683,7 +257584,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206726,7 +257627,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206747,6 +257648,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/professionalDevelopmentEventAttendances/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProfessionalDevelopmentEventAttendancesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEventAttendance_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "professionalDevelopmentEventAttendances" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/professionalDevelopmentEventAttendances/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProfessionalDevelopmentEventAttendancesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEventAttendance_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "professionalDevelopmentEventAttendances" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/professionalDevelopmentEventAttendances/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -206782,7 +257803,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206814,15 +257835,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -206849,7 +257861,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206906,7 +257918,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -207222,6 +258234,69 @@ "professionalDevelopmentTitle" ], "type": "object" + }, + "EdFi_ProfessionalDevelopmentEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProfessionalDevelopmentEvent_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "professionalDevelopmentTitle": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "namespace", + "professionalDevelopmentTitle" + ], + "type": "object" + }, + "EdFi_ProfessionalDevelopmentEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -207348,7 +258423,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207391,7 +258466,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -207412,6 +258487,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/professionalDevelopmentEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProfessionalDevelopmentEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "professionalDevelopmentEvents" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/professionalDevelopmentEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProfessionalDevelopmentEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "professionalDevelopmentEvents" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/professionalDevelopmentEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -207447,7 +258642,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -207479,15 +258674,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -207514,7 +258700,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207571,7 +258757,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -207803,6 +258989,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProfessionalDevelopmentOfferedByDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentOfferedByDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProfessionalDevelopmentOfferedByDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProfessionalDevelopmentOfferedByDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentOfferedByDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentOfferedByDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -207919,7 +259166,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207962,7 +259209,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -207982,6 +259229,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/professionalDevelopmentOfferedByDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProfessionalDevelopmentOfferedBiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentOfferedByDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "professionalDevelopmentOfferedByDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/professionalDevelopmentOfferedByDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProfessionalDevelopmentOfferedBiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentOfferedByDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "professionalDevelopmentOfferedByDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/professionalDevelopmentOfferedByDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -208017,7 +259382,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -208049,15 +259414,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -208084,7 +259440,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -208141,7 +259497,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -208367,6 +259723,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProficiencyDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProficiencyDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProficiencyDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -208483,7 +259900,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -208526,7 +259943,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -208547,6 +259964,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/proficiencyDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProficienciesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "proficiencyDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/proficiencyDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProficienciesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "proficiencyDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/proficiencyDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -208582,7 +260119,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -208614,15 +260151,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -208649,7 +260177,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -208706,7 +260234,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -208935,6 +260463,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramAssignmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramAssignmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramAssignmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -209051,7 +260640,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209094,7 +260683,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209117,6 +260706,130 @@ "SectionsAndPrograms" ] }, + "/ed-fi/programAssignmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramAssignmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programAssignmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/programAssignmentDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramAssignmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programAssignmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/programAssignmentDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -209152,7 +260865,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209184,15 +260897,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -209219,7 +260923,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209276,7 +260980,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209516,6 +261220,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -209632,7 +261397,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209675,7 +261440,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209707,6 +261472,148 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramCharacteristicsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programCharacteristicDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramCharacteristicsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programCharacteristicDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -209742,7 +261649,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209774,15 +261681,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -209809,7 +261707,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209866,7 +261764,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -210165,6 +262063,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ProgramDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ProgramDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -210254,7 +262213,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -210297,7 +262256,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -210318,6 +262277,126 @@ "Finance" ] }, + "/ed-fi/programDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/programDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/programDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -210353,7 +262432,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -210385,15 +262464,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -210420,7 +262490,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -210477,7 +262547,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -211091,6 +263161,92 @@ "programEvaluationElementTitle" ], "type": "object" + }, + "EdFi_ProgramEvaluationElement_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationElement_TrackedChangeKey": { + "properties": { + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationElementTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "programEducationOrganizationId", + "programEvaluationElementTitle", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationElement_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -211267,7 +263423,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -211310,7 +263466,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -211332,6 +263488,128 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programEvaluationElements/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationElementsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programEvaluationElements" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationElements/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationElementsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programEvaluationElements" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programEvaluationElements/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -211367,7 +263645,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -211399,15 +263677,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -211434,7 +263703,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -211491,7 +263760,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -212044,6 +264313,92 @@ "programEvaluationObjectiveTitle" ], "type": "object" + }, + "EdFi_ProgramEvaluationObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationObjective_TrackedChangeKey": { + "properties": { + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationObjectiveTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "programEducationOrganizationId", + "programEvaluationObjectiveTitle", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -212210,7 +264565,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212253,7 +264608,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -212275,6 +264630,128 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programEvaluationObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationObjectivesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programEvaluationObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationObjectives/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationObjectivesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programEvaluationObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programEvaluationObjectives/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -212310,7 +264787,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -212342,15 +264819,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -212377,7 +264845,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212434,7 +264902,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -212703,6 +265171,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -212819,7 +265348,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212862,7 +265391,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -212884,6 +265413,128 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programEvaluationPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationPeriodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programEvaluationPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationPeriodDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationPeriodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programEvaluationPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programEvaluationPeriodDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -212919,7 +265570,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -212951,15 +265602,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -212986,7 +265628,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -213043,7 +265685,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -213272,6 +265914,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -213388,7 +266091,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -213431,7 +266134,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -213453,6 +266156,128 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programEvaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programEvaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programEvaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programEvaluationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -213488,7 +266313,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -213520,15 +266345,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -213555,7 +266371,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -213612,7 +266428,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214104,6 +266920,87 @@ "programEvaluationTypeDescriptor" ], "type": "object" + }, + "EdFi_ProgramEvaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluation_TrackedChangeKey": { + "properties": { + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "programEducationOrganizationId", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_ProgramEvaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -214251,7 +267148,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214294,7 +267191,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214316,6 +267213,128 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programEvaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programEvaluations" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programEvaluations" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programEvaluations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -214351,7 +267370,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214383,15 +267402,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -214418,7 +267428,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214475,7 +267485,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214741,6 +267751,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramSponsorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramSponsorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramSponsorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -214857,7 +267928,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214900,7 +267971,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214932,6 +268003,148 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programSponsorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramSponsorsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programSponsorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programSponsorDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramSponsorsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programSponsorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programSponsorDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -214967,7 +268180,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214999,15 +268212,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -215034,7 +268238,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215091,7 +268295,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -215341,6 +268545,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -215457,7 +268722,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215500,7 +268765,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -215533,6 +268798,150 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "EducatorPreparationProgram", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "EducatorPreparationProgram", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -215568,7 +268977,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -215600,15 +269009,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -215635,7 +269035,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215692,7 +269092,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -216161,6 +269561,72 @@ "programTypeDescriptor" ], "type": "object" + }, + "EdFi_Program_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Program_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_Program_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -216260,7 +269726,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -216303,7 +269769,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -216335,6 +269801,148 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programs" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programs/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programs" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programs/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -216370,7 +269978,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -216402,15 +270010,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -216437,7 +270036,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -216494,7 +270093,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -216729,6 +270328,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgressDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgressDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgressDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -216845,7 +270505,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -216888,7 +270548,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -216909,6 +270569,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/progressDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgressesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "progressDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/progressDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgressesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "progressDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/progressDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -216944,7 +270724,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -216976,15 +270756,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -217011,7 +270782,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217068,7 +270839,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -217295,6 +271066,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgressLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgressLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgressLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -217411,7 +271243,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217454,7 +271286,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -217475,6 +271307,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/progressLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgressLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "progressLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/progressLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgressLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "progressLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/progressLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -217510,7 +271462,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -217542,15 +271494,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -217577,7 +271520,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217634,7 +271577,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -217922,6 +271865,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ProjectDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProjectDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ProjectDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -218011,7 +272015,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218054,7 +272058,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -218075,6 +272079,126 @@ "Finance" ] }, + "/ed-fi/projectDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProjectDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "projectDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/projectDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProjectDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "projectDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/projectDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -218110,7 +272234,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -218142,15 +272266,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -218177,7 +272292,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218234,7 +272349,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -218442,6 +272557,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProviderCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProviderCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProviderCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -218558,7 +272734,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218601,7 +272777,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -218622,6 +272798,126 @@ "EducationOrganization" ] }, + "/ed-fi/providerCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProviderCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "providerCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/providerCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProviderCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "providerCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/providerCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -218657,7 +272953,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -218689,15 +272985,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -218724,7 +273011,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218781,7 +273068,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -219008,6 +273295,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProviderProfitabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProviderProfitabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -219124,7 +273472,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219167,7 +273515,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -219188,6 +273536,126 @@ "EducationOrganization" ] }, + "/ed-fi/providerProfitabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProviderProfitabilitiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "providerProfitabilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/providerProfitabilityDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProviderProfitabilitiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "providerProfitabilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/providerProfitabilityDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -219223,7 +273691,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -219255,15 +273723,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -219290,7 +273749,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219347,7 +273806,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -219574,6 +274033,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProviderStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProviderStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProviderStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -219690,7 +274210,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219733,7 +274253,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -219754,6 +274274,126 @@ "EducationOrganization" ] }, + "/ed-fi/providerStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProviderStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "providerStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/providerStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProviderStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "providerStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/providerStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -219789,7 +274429,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -219821,15 +274461,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -219856,7 +274487,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219913,7 +274544,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -220147,6 +274778,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PublicationStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PublicationStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PublicationStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -220263,7 +274955,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220306,7 +274998,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -220334,6 +275026,140 @@ "Standards" ] }, + "/ed-fi/publicationStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPublicationStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "publicationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, + "/ed-fi/publicationStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPublicationStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "publicationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, "/ed-fi/publicationStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -220369,7 +275195,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -220401,15 +275227,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -220436,7 +275253,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220493,7 +275310,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -220727,6 +275544,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_QuantitativeMeasureDatatypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureDatatypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_QuantitativeMeasureDatatypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_QuantitativeMeasureDatatypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureDatatypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureDatatypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -220843,7 +275721,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220886,7 +275764,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -220907,6 +275785,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/quantitativeMeasureDatatypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getQuantitativeMeasureDatatypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureDatatypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "quantitativeMeasureDatatypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/quantitativeMeasureDatatypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getQuantitativeMeasureDatatypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureDatatypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "quantitativeMeasureDatatypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/quantitativeMeasureDatatypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -220942,7 +275940,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -220974,15 +275972,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -221009,7 +275998,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -221066,7 +276055,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -221776,6 +276765,127 @@ "quantitativeMeasureIdentifier" ], "type": "object" + }, + "EdFi_QuantitativeMeasureScore_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureScore_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_QuantitativeMeasureScore_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationDate": { + "format": "date-time", + "type": "string" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "quantitativeMeasureIdentifier": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationDate", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "quantitativeMeasureIdentifier", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_QuantitativeMeasureScore_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureScore_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureScore_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -221989,7 +277099,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -222032,7 +277142,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -222053,6 +277163,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/quantitativeMeasureScores/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getQuantitativeMeasureScoresDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureScore_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "quantitativeMeasureScores" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/quantitativeMeasureScores/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getQuantitativeMeasureScoresKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureScore_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "quantitativeMeasureScores" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/quantitativeMeasureScores/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -222088,7 +277318,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -222120,15 +277350,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -222155,7 +277376,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -222212,7 +277433,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -222500,6 +277721,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_QuantitativeMeasureTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_QuantitativeMeasureTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_QuantitativeMeasureTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -222616,7 +277898,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -222659,7 +277941,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -222680,6 +277962,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/quantitativeMeasureTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getQuantitativeMeasureTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "quantitativeMeasureTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/quantitativeMeasureTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getQuantitativeMeasureTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "quantitativeMeasureTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/quantitativeMeasureTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -222715,7 +278117,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -222747,15 +278149,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -222782,7 +278175,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -222839,7 +278232,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -223276,6 +278669,112 @@ "quantitativeMeasureIdentifier" ], "type": "object" + }, + "EdFi_QuantitativeMeasure_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasure_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_QuantitativeMeasure_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "quantitativeMeasureIdentifier": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "quantitativeMeasureIdentifier", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_QuantitativeMeasure_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasure_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasure_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -223459,7 +278958,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223502,7 +279001,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -223523,6 +279022,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/quantitativeMeasures/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getQuantitativeMeasuresDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasure_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "quantitativeMeasures" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/quantitativeMeasures/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getQuantitativeMeasuresKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasure_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "quantitativeMeasures" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/quantitativeMeasures/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -223558,7 +279177,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -223590,15 +279209,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -223625,7 +279235,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223682,7 +279292,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -223948,6 +279558,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_QuestionFormDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_QuestionFormDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_QuestionFormDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -224064,7 +279735,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224107,7 +279778,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -224128,6 +279799,126 @@ "Survey" ] }, + "/ed-fi/questionFormDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getQuestionFormsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "questionFormDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/questionFormDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getQuestionFormsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "questionFormDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/questionFormDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -224163,7 +279954,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -224195,15 +279986,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -224230,7 +280012,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224287,7 +280069,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -224528,6 +280310,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RaceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RaceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RaceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -224644,7 +280487,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224687,7 +280530,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -224722,6 +280565,154 @@ "SectionsAndPrograms" ] }, + "/ed-fi/raceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRacesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "raceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Intervention", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/raceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRacesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "raceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Intervention", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/raceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -224757,7 +280748,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -224789,15 +280780,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -224824,7 +280806,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224881,7 +280863,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225124,6 +281106,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -225240,7 +281283,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225283,7 +281326,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225306,6 +281349,130 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/ratingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "ratingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation", + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/ratingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "ratingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation", + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/ratingLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -225341,7 +281508,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225373,15 +281540,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -225408,7 +281566,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225465,7 +281623,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225695,6 +281853,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReasonExitedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReasonExitedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReasonExitedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -225811,7 +282030,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225854,7 +282073,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225876,6 +282095,128 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/reasonExitedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReasonExitedsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "reasonExitedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "EducatorPreparationProgram" + ] + }, + "/ed-fi/reasonExitedDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReasonExitedsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "reasonExitedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "EducatorPreparationProgram" + ] + }, "/ed-fi/reasonExitedDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -225911,7 +282252,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225943,15 +282284,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -225978,7 +282310,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226035,7 +282367,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -226264,6 +282596,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReasonNotTestedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReasonNotTestedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReasonNotTestedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -226380,7 +282773,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226423,7 +282816,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -226445,6 +282838,128 @@ "StudentAssessment" ] }, + "/ed-fi/reasonNotTestedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReasonNotTestedsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "reasonNotTestedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/reasonNotTestedDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReasonNotTestedsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "reasonNotTestedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, "/ed-fi/reasonNotTestedDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -226480,7 +282995,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -226512,15 +283027,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -226547,7 +283053,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226604,7 +283110,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -226845,6 +283351,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RecognitionTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RecognitionTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RecognitionTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -226961,7 +283528,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -227004,7 +283571,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -227038,6 +283605,152 @@ "StudentTranscript" ] }, + "/ed-fi/recognitionTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRecognitionTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "recognitionTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Graduation", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/recognitionTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRecognitionTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "recognitionTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Graduation", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/recognitionTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -227073,7 +283786,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -227105,15 +283818,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -227140,7 +283844,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -227197,7 +283901,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -228737,6 +285441,78 @@ "touchpointDate" ], "type": "object" + }, + "EdFi_RecruitmentEventAttendance_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RecruitmentEventAttendance_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "eventTitle": { + "maxLength": 50, + "type": "string" + }, + "recruitmentEventAttendeeIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "eventDate", + "eventTitle", + "recruitmentEventAttendeeIdentifier" + ], + "type": "object" + }, + "EdFi_RecruitmentEventAttendance_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendance_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -229028,7 +285804,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229071,7 +285847,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229092,6 +285868,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/recruitmentEventAttendances/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRecruitmentEventAttendancesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendance_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "recruitmentEventAttendances" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/recruitmentEventAttendances/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRecruitmentEventAttendancesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendance_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "recruitmentEventAttendances" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/recruitmentEventAttendances/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -229127,7 +286023,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229159,15 +286055,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -229194,7 +286081,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229251,7 +286138,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229603,6 +286490,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RecruitmentEventAttendeeTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendeeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RecruitmentEventAttendeeTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RecruitmentEventAttendeeTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendeeTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendeeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -229719,7 +286667,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229762,7 +286710,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229783,6 +286731,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/recruitmentEventAttendeeTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRecruitmentEventAttendeeTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendeeTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "recruitmentEventAttendeeTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/recruitmentEventAttendeeTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRecruitmentEventAttendeeTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendeeTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "recruitmentEventAttendeeTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/recruitmentEventAttendeeTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -229818,7 +286886,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229850,15 +286918,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -229885,7 +286944,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229942,7 +287001,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230169,6 +287228,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RecruitmentEventTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RecruitmentEventTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RecruitmentEventTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -230285,7 +287405,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230328,7 +287448,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230349,6 +287469,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/recruitmentEventTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRecruitmentEventTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "recruitmentEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/recruitmentEventTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRecruitmentEventTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "recruitmentEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/recruitmentEventTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -230384,7 +287624,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230416,15 +287656,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -230451,7 +287682,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230508,7 +287739,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230819,6 +288050,72 @@ "eventTitle" ], "type": "object" + }, + "EdFi_RecruitmentEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RecruitmentEvent_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "eventTitle": { + "maxLength": 50, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "eventDate", + "eventTitle" + ], + "type": "object" + }, + "EdFi_RecruitmentEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -230936,7 +288233,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230979,7 +288276,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231000,6 +288297,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/recruitmentEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRecruitmentEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecruitmentEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "recruitmentEvents" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/recruitmentEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRecruitmentEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecruitmentEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "recruitmentEvents" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/recruitmentEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -231035,7 +288452,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231067,15 +288484,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -231102,7 +288510,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231159,7 +288567,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231389,6 +288797,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RelationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RelationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RelationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -231505,7 +288974,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231548,7 +289017,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231569,6 +289038,126 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/relationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRelationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "relationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/relationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRelationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "relationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/relationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -231604,7 +289193,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231636,15 +289225,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -231671,7 +289251,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231728,7 +289308,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231963,6 +289543,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RepeatIdentifierDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RepeatIdentifierDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RepeatIdentifierDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -232079,7 +289720,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232122,7 +289763,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -232151,6 +289792,142 @@ "SectionsAndPrograms" ] }, + "/ed-fi/repeatIdentifierDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRepeatIdentifiersDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "repeatIdentifierDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/repeatIdentifierDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRepeatIdentifiersKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "repeatIdentifierDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/repeatIdentifierDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -232186,7 +289963,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -232218,15 +289995,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -232253,7 +290021,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232310,7 +290078,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -233224,6 +290992,87 @@ "studentCompetencyObjectiveReference" ], "type": "object" + }, + "EdFi_ReportCard_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReportCard_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "type": "string" + }, + "gradingPeriodSchoolId": { + "format": "int64", + "type": "integer" + }, + "gradingPeriodSchoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolId", + "gradingPeriodSchoolYear", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_ReportCard_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -233371,7 +291220,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233414,7 +291263,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -233436,6 +291285,128 @@ "ReportCard" ] }, + "/ed-fi/reportCards/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReportCardsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "reportCards" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/reportCards/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReportCardsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "reportCards" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, "/ed-fi/reportCards/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -233471,7 +291442,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -233503,15 +291474,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -233538,7 +291500,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233595,7 +291557,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -233850,6 +291812,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReporterDescriptionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReporterDescriptionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReporterDescriptionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -233966,7 +291989,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234009,7 +292032,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -234030,6 +292053,126 @@ "Discipline" ] }, + "/ed-fi/reporterDescriptionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReporterDescriptionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "reporterDescriptionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/reporterDescriptionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReporterDescriptionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "reporterDescriptionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/reporterDescriptionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -234065,7 +292208,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -234097,15 +292240,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -234132,7 +292266,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234189,7 +292323,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -234416,6 +292550,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReportingTagDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReportingTagDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReportingTagDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -234532,7 +292727,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234575,7 +292770,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -234596,6 +292791,126 @@ "Finance" ] }, + "/ed-fi/reportingTagDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReportingTagsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "reportingTagDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/reportingTagDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReportingTagsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "reportingTagDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/reportingTagDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -234631,7 +292946,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -234663,15 +292978,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -234698,7 +293004,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -234755,7 +293061,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -234986,6 +293292,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResidencyStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResidencyStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResidencyStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -235102,7 +293469,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235145,7 +293512,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235170,6 +293537,134 @@ "SectionsAndPrograms" ] }, + "/ed-fi/residencyStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResidencyStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "residencyStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/residencyStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResidencyStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "residencyStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/residencyStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -235205,7 +293700,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235237,15 +293732,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -235272,7 +293758,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235329,7 +293815,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235561,6 +294047,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResponseIndicatorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResponseIndicatorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResponseIndicatorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -235677,7 +294224,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235720,7 +294267,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235742,6 +294289,128 @@ "StudentAssessment" ] }, + "/ed-fi/responseIndicatorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResponseIndicatorsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "responseIndicatorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/responseIndicatorDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResponseIndicatorsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "responseIndicatorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, "/ed-fi/responseIndicatorDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -235777,7 +294446,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235809,15 +294478,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -235844,7 +294504,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235901,7 +294561,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236129,6 +294789,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResponsibilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResponsibilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResponsibilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -236245,7 +294966,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236288,7 +295009,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236309,6 +295030,126 @@ "Enrollment" ] }, + "/ed-fi/responsibilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResponsibilitiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "responsibilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/responsibilityDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResponsibilitiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "responsibilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/responsibilityDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -236344,7 +295185,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236376,15 +295217,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -236411,7 +295243,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236468,7 +295300,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236695,6 +295527,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RestraintEventReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RestraintEventReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RestraintEventReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -236811,7 +295704,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236854,7 +295747,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236875,6 +295768,126 @@ "SpecialEducation" ] }, + "/ed-fi/restraintEventReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "restraintEventReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, + "/ed-fi/restraintEventReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "restraintEventReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, "/ed-fi/restraintEventReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -236910,7 +295923,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236942,15 +295955,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -236977,7 +295981,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237034,7 +296038,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237534,6 +296538,72 @@ "restraintEventReasonDescriptor" ], "type": "object" + }, + "EdFi_RestraintEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RestraintEvent_TrackedChangeKey": { + "properties": { + "restraintEventIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "restraintEventIdentifier", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_RestraintEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -237652,7 +296722,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237695,7 +296765,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237716,6 +296786,126 @@ "SpecialEducation" ] }, + "/ed-fi/restraintEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "restraintEvents" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, + "/ed-fi/restraintEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "restraintEvents" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, "/ed-fi/restraintEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -237751,7 +296941,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237783,15 +296973,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -237818,7 +296999,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237875,7 +297056,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238115,6 +297296,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResultDatatypeTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -238231,7 +297473,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238274,7 +297516,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238299,6 +297541,134 @@ "StudentAssessment" ] }, + "/ed-fi/resultDatatypeTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResultDatatypeTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "resultDatatypeTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "PerformanceEvaluation", + "RecruitingAndStaffing", + "AssessmentMetadata", + "StudentAssessment" + ] + }, + "/ed-fi/resultDatatypeTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResultDatatypeTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "resultDatatypeTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "PerformanceEvaluation", + "RecruitingAndStaffing", + "AssessmentMetadata", + "StudentAssessment" + ] + }, "/ed-fi/resultDatatypeTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -238334,7 +297704,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238366,15 +297736,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -238401,7 +297762,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238458,7 +297819,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238690,6 +298051,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RetestIndicatorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RetestIndicatorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RetestIndicatorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -238806,7 +298228,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238849,7 +298271,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238871,6 +298293,128 @@ "StudentAssessment" ] }, + "/ed-fi/retestIndicatorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRetestIndicatorsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "retestIndicatorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/retestIndicatorDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRetestIndicatorsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "retestIndicatorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, "/ed-fi/retestIndicatorDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -238906,7 +298450,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238938,15 +298482,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -238973,7 +298508,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239030,7 +298565,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239483,6 +299018,111 @@ "rubricRating" ], "type": "object" + }, + "EdFi_RubricDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RubricDimension_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "rubricRating": { + "format": "int32", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "rubricRating", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_RubricDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RubricDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -239674,7 +299314,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239717,7 +299357,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239738,6 +299378,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/rubricDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRubricDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RubricDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "rubricDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/rubricDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRubricDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RubricDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "rubricDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/rubricDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -239773,7 +299533,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239805,15 +299565,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -239840,7 +299591,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239897,7 +299648,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240168,6 +299919,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RubricRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RubricRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RubricRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RubricRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RubricRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RubricRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -240284,7 +300096,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240327,7 +300139,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240347,6 +300159,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/rubricRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRubricRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RubricRatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "rubricRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/rubricRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRubricRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RubricRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "rubricRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/rubricRatingLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -240382,7 +300312,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240414,15 +300344,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -240449,7 +300370,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240506,7 +300427,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240732,6 +300653,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SalaryTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SalaryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SalaryTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SalaryTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SalaryTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SalaryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -240848,7 +300830,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240891,7 +300873,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240912,6 +300894,126 @@ "Staff" ] }, + "/ed-fi/salaryTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSalaryTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SalaryTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "salaryTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/salaryTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSalaryTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SalaryTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "salaryTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/salaryTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -240947,7 +301049,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240979,15 +301081,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -241014,7 +301107,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241071,7 +301164,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241311,6 +301404,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -241427,7 +301581,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241470,7 +301624,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241504,6 +301658,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/schoolCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/schoolCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/schoolCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -241539,7 +301839,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241571,15 +301871,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -241606,7 +301897,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241663,7 +301954,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241907,6 +302198,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolChoiceBasisDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -242023,7 +302375,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242066,7 +302418,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242091,6 +302443,134 @@ "SectionsAndPrograms" ] }, + "/ed-fi/schoolChoiceBasisDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceBasesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolChoiceBasisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/schoolChoiceBasisDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceBasesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolChoiceBasisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/schoolChoiceBasisDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -242126,7 +302606,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242158,15 +302638,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -242193,7 +302664,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242250,7 +302721,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242483,6 +302954,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -242599,7 +303131,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242642,7 +303174,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242665,6 +303197,130 @@ "Staff" ] }, + "/ed-fi/schoolChoiceImplementStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceImplementStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolChoiceImplementStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, + "/ed-fi/schoolChoiceImplementStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceImplementStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolChoiceImplementStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, "/ed-fi/schoolChoiceImplementStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -242700,7 +303356,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242732,15 +303388,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -242767,7 +303414,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242824,7 +303471,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243053,6 +303700,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -243169,7 +303877,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243212,7 +303920,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243233,6 +303941,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/schoolFoodServiceProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolFoodServiceProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolFoodServiceProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/schoolFoodServiceProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolFoodServiceProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolFoodServiceProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/schoolFoodServiceProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -243268,7 +304096,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243300,15 +304128,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -243335,7 +304154,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243392,7 +304211,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243632,6 +304451,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -243748,7 +304628,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243791,7 +304671,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243825,6 +304705,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/schoolTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/schoolTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/schoolTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -243860,7 +304886,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243892,15 +304918,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -243927,7 +304944,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243984,7 +305001,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244192,6 +305209,62 @@ "schoolYear" ], "type": "object" + }, + "EdFi_SchoolYear_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolYear_TrackedChangeKey": { + "properties": { + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "schoolYear" + ], + "type": "object" + }, + "EdFi_SchoolYear_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -244277,7 +305350,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244320,7 +305393,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244340,6 +305413,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/schoolYearTypes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolYearsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolYearTypes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolYearTypes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolYearsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolYearTypes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/schoolYearTypes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -244375,7 +305566,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244407,15 +305598,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -244442,7 +305624,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244499,7 +305681,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246102,6 +307284,62 @@ "schoolCategoryDescriptor" ], "type": "object" + }, + "EdFi_School_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_School_TrackedChangeKey": { + "properties": { + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "schoolId" + ], + "type": "object" + }, + "EdFi_School_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -246327,7 +307565,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246370,7 +307608,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246404,6 +307642,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/schools/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schools" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/schools/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schools" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/schools/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -246439,7 +307823,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246471,15 +307855,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -246506,7 +307881,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246563,7 +307938,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246890,6 +308265,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_Section504DisabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Section504DisabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_Section504DisabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -247006,7 +308442,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247049,7 +308485,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247070,6 +308506,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/section504DisabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSection504DisabilitiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "section504DisabilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/section504DisabilityDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSection504DisabilitiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "section504DisabilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/section504DisabilityDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -247105,7 +308661,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247137,15 +308693,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -247172,7 +308719,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247229,7 +308776,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247660,6 +309207,92 @@ "sectionIdentifier" ], "type": "object" + }, + "EdFi_SectionAttendanceTakenEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SectionAttendanceTakenEvent_TrackedChangeKey": { + "properties": { + "calendarCode": { + "maxLength": 120, + "type": "string" + }, + "date": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "calendarCode", + "date", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName" + ], + "type": "object" + }, + "EdFi_SectionAttendanceTakenEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -247809,7 +309442,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247852,7 +309485,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247873,6 +309506,126 @@ "StudentAttendance" ] }, + "/ed-fi/sectionAttendanceTakenEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionAttendanceTakenEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "sectionAttendanceTakenEvents" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAttendance" + ] + }, + "/ed-fi/sectionAttendanceTakenEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionAttendanceTakenEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "sectionAttendanceTakenEvents" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAttendance" + ] + }, "/ed-fi/sectionAttendanceTakenEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -247908,7 +309661,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247940,15 +309693,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -247975,7 +309719,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248032,7 +309776,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248296,6 +310040,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SectionCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SectionCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SectionCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -248412,7 +310217,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248455,7 +310260,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248488,6 +310293,150 @@ "SectionsAndPrograms" ] }, + "/ed-fi/sectionCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionCharacteristicsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "sectionCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sectionCharacteristicDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionCharacteristicsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "sectionCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/sectionCharacteristicDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -248523,7 +310472,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248555,15 +310504,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -248590,7 +310530,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248647,7 +310587,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248898,6 +310838,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SectionTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SectionTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SectionTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -249014,7 +311015,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249057,7 +311058,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249090,6 +311091,150 @@ "SectionsAndPrograms" ] }, + "/ed-fi/sectionTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "sectionTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sectionTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "sectionTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/sectionTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -249125,7 +311270,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249157,15 +311302,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -249192,7 +311328,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249249,7 +311385,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250208,6 +312344,82 @@ "sectionCharacteristicDescriptor" ], "type": "object" + }, + "EdFi_Section_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Section_TrackedChangeKey": { + "properties": { + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName" + ], + "type": "object" + }, + "EdFi_Section_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -250436,7 +312648,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250479,7 +312691,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250512,6 +312724,150 @@ "SectionsAndPrograms" ] }, + "/ed-fi/sections/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "sections" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sections/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "sections" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/sections/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -250547,7 +312903,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250579,15 +312935,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -250614,7 +312961,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250671,7 +313018,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250993,6 +313340,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SeparationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SeparationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SeparationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -251109,7 +313517,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251152,7 +313560,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -251173,6 +313581,126 @@ "Staff" ] }, + "/ed-fi/separationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "separationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/separationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "separationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/separationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -251208,7 +313736,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -251240,15 +313768,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -251275,7 +313794,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251332,7 +313851,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -251559,6 +314078,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SeparationReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SeparationReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SeparationReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -251675,7 +314255,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251718,7 +314298,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -251739,6 +314319,126 @@ "Staff" ] }, + "/ed-fi/separationReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "separationReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/separationReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "separationReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/separationReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -251774,7 +314474,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -251806,15 +314506,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -251841,7 +314532,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -251898,7 +314589,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252131,6 +314822,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -252247,7 +314999,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252290,7 +315042,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252317,6 +315069,138 @@ "SectionsAndPrograms" ] }, + "/ed-fi/serviceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "serviceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/serviceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "serviceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/serviceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -252352,7 +315236,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252384,15 +315268,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -252419,7 +315294,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252476,7 +315351,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -253031,6 +315906,72 @@ "sessionName" ], "type": "object" + }, + "EdFi_Session_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Session_TrackedChangeKey": { + "properties": { + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ], + "type": "object" + }, + "EdFi_Session_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -253157,7 +316098,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253200,7 +316141,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -253228,6 +316169,140 @@ "SectionsAndPrograms" ] }, + "/ed-fi/sessions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSessionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "sessions" + ] + }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "SchoolCalendar", + "StudentAcademicRecord", + "StudentAttendance", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sessions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSessionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "sessions" + ] + }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "SchoolCalendar", + "StudentAcademicRecord", + "StudentAttendance", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/sessions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -253263,7 +316338,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -253295,15 +316370,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -253330,7 +316396,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253387,7 +316453,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -253654,6 +316720,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SexDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SexDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SexDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -253770,7 +316897,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253813,7 +316940,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -253857,6 +316984,172 @@ "StudentTranscript" ] }, + "/ed-fi/sexDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSexesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "sexDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/sexDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSexesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "sexDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/sexDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -253892,7 +317185,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -253924,15 +317217,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -253959,7 +317243,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254016,7 +317300,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -254327,6 +317611,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_SourceDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SourceDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_SourceDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -254416,7 +317761,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254459,7 +317804,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -254480,6 +317825,126 @@ "Finance" ] }, + "/ed-fi/sourceDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSourceDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "sourceDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/sourceDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSourceDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "sourceDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/sourceDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -254515,7 +317980,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -254547,15 +318012,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -254582,7 +318038,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254639,7 +318095,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -254848,6 +318304,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SourceSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SourceSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SourceSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -254964,7 +318481,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255007,7 +318524,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -255029,6 +318546,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/sourceSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSourceSystemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "sourceSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/sourceSystemDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSourceSystemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "sourceSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/sourceSystemDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -255064,7 +318703,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -255096,15 +318735,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -255131,7 +318761,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255188,7 +318818,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -255417,6 +319047,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -255533,7 +319224,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255576,7 +319267,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -255598,6 +319289,128 @@ "SpecialEducation" ] }, + "/ed-fi/specialEducationExitReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationExitReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "specialEducationExitReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation" + ] + }, + "/ed-fi/specialEducationExitReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationExitReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "specialEducationExitReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation" + ] + }, "/ed-fi/specialEducationExitReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -255633,7 +319446,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -255665,15 +319478,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -255700,7 +319504,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255757,7 +319561,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -255986,6 +319790,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -256102,7 +319967,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256145,7 +320010,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -256167,6 +320032,128 @@ "SpecialEducation" ] }, + "/ed-fi/specialEducationProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "specialEducationProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation" + ] + }, + "/ed-fi/specialEducationProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "specialEducationProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation" + ] + }, "/ed-fi/specialEducationProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -256202,7 +320189,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -256234,15 +320221,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -256269,7 +320247,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256326,7 +320304,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -256555,6 +320533,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SpecialEducationSettingDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SpecialEducationSettingDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -256671,7 +320710,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256714,7 +320753,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -256736,6 +320775,128 @@ "SpecialEducation" ] }, + "/ed-fi/specialEducationSettingDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationSettingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "specialEducationSettingDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation" + ] + }, + "/ed-fi/specialEducationSettingDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationSettingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "specialEducationSettingDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation" + ] + }, "/ed-fi/specialEducationSettingDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -256771,7 +320932,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -256803,15 +320964,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -256838,7 +320990,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256895,7 +321047,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257192,6 +321344,72 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffAbsenceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffAbsenceEvent_TrackedChangeKey": { + "properties": { + "absenceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "absenceEventCategoryDescriptor", + "eventDate", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffAbsenceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -257300,7 +321518,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257343,7 +321561,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257364,6 +321582,126 @@ "Staff" ] }, + "/ed-fi/staffAbsenceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffAbsenceEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffAbsenceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffAbsenceEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffAbsenceEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffAbsenceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffAbsenceEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -257399,7 +321737,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257431,15 +321769,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -257466,7 +321795,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257523,7 +321852,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257744,6 +322073,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffClassificationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffClassificationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffClassificationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -257860,7 +322250,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257903,7 +322293,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257924,6 +322314,126 @@ "Staff" ] }, + "/ed-fi/staffClassificationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffClassificationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffClassificationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffClassificationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffClassificationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffClassificationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffClassificationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -257959,7 +322469,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257991,15 +322501,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -258026,7 +322527,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258083,7 +322584,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -258407,6 +322908,77 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffCohortAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffCohortAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "cohortIdentifier": { + "maxLength": 36, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "cohortIdentifier", + "educationOrganizationId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffCohortAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -258524,7 +323096,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258567,7 +323139,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -258588,6 +323160,126 @@ "StudentCohort" ] }, + "/ed-fi/staffCohortAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffCohortAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffCohortAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "StudentCohort" + ] + }, + "/ed-fi/staffCohortAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffCohortAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffCohortAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "StudentCohort" + ] + }, "/ed-fi/staffCohortAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -258623,7 +323315,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -258655,15 +323347,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -258690,7 +323373,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258747,7 +323430,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -259549,6 +324232,67 @@ ], "type": "object" }, + "EdFi_StaffDemographic_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffDemographic_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffDemographic_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffDemographic_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDemographic_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDemographic_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_StaffDemographic_TribalAffiliation": { "properties": { "tribalAffiliationDescriptor": { @@ -259676,7 +324420,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -259719,7 +324463,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -259740,6 +324484,126 @@ "Staff" ] }, + "/ed-fi/staffDemographics/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDemographicsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffDemographic_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffDemographics" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffDemographics/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDemographicsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffDemographic_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffDemographics" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffDemographics/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -259775,7 +324639,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -259807,15 +324671,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -259842,7 +324697,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -259899,7 +324754,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -260994,6 +325849,67 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "EdFi_StaffDirectory_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffDirectory_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffDirectory_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffDirectory_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDirectory_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDirectory_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -261074,7 +325990,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -261117,7 +326033,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -261138,6 +326054,126 @@ "Staff" ] }, + "/ed-fi/staffDirectories/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDirectoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffDirectory_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffDirectories" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffDirectories/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDirectoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffDirectory_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffDirectories" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffDirectories/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -261173,7 +326209,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -261205,15 +326241,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -261240,7 +326267,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -261297,7 +326324,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -261593,6 +326620,72 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffDisciplineIncidentAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey": { + "properties": { + "incidentIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "incidentIdentifier", + "schoolId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -261683,7 +326776,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -261726,7 +326819,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -261747,6 +326840,126 @@ "Discipline" ] }, + "/ed-fi/staffDisciplineIncidentAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDisciplineIncidentAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffDisciplineIncidentAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/staffDisciplineIncidentAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDisciplineIncidentAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffDisciplineIncidentAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/staffDisciplineIncidentAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -261782,7 +326995,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -261814,15 +327027,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -261849,7 +327053,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -261906,7 +327110,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -262412,6 +327616,77 @@ "staffClassificationDescriptor" ], "type": "object" + }, + "EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffClassificationDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "staffClassificationDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -262607,7 +327882,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -262650,7 +327925,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -262671,6 +327946,126 @@ "Staff" ] }, + "/ed-fi/staffEducationOrganizationAssignmentAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationAssignmentAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffEducationOrganizationAssignmentAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationAssignmentAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationAssignmentAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffEducationOrganizationAssignmentAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffEducationOrganizationAssignmentAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -262706,7 +328101,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -262738,15 +328133,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -262773,7 +328159,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -262830,7 +328216,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -263802,6 +329188,77 @@ "yearsExperience" ], "type": "object" + }, + "EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "employmentStatusDescriptor": { + "maxLength": 306, + "type": "string" + }, + "hireDate": { + "format": "date", + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "employmentStatusDescriptor", + "hireDate", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -264028,7 +329485,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -264071,7 +329528,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -264092,6 +329549,126 @@ "Staff" ] }, + "/ed-fi/staffEducationOrganizationEmploymentAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationEmploymentAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffEducationOrganizationEmploymentAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationEmploymentAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationEmploymentAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffEducationOrganizationEmploymentAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffEducationOrganizationEmploymentAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -264127,7 +329704,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -264159,15 +329736,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -264194,7 +329762,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -264251,7 +329819,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -264663,6 +330231,78 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffEducatorPreparationProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducatorPreparationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffEducatorPreparationProgramAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffEducatorPreparationProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducatorPreparationProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducatorPreparationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -264790,7 +330430,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -264833,7 +330473,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -264854,6 +330494,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/staffEducatorPreparationProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducatorPreparationProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducatorPreparationProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffEducatorPreparationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/staffEducatorPreparationProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducatorPreparationProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducatorPreparationProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffEducatorPreparationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/staffEducatorPreparationProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -264889,7 +330649,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -264921,15 +330681,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -264956,7 +330707,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -265013,7 +330764,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -265331,6 +331082,72 @@ "staffIdentificationSystemDescriptor" ], "type": "object" + }, + "EdFi_StaffIdentificationCode_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffIdentificationCode_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffIdentificationSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "staffIdentificationSystemDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffIdentificationCode_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationCode_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -265439,7 +331256,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -265482,7 +331299,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -265503,6 +331320,126 @@ "Staff" ] }, + "/ed-fi/staffIdentificationCodes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffIdentificationCodesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationCode_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffIdentificationCodes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffIdentificationCodesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationCode_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffIdentificationCodes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -265538,7 +331475,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -265570,15 +331507,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -265605,7 +331533,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -265662,7 +331590,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -265897,6 +331825,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -266013,7 +332002,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -266056,7 +332045,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -266087,6 +332076,146 @@ "SectionsAndPrograms" ] }, + "/ed-fi/staffIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffIdentificationSystemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffIdentificationSystemDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffIdentificationSystemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/staffIdentificationSystemDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -266122,7 +332251,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -266154,15 +332283,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -266189,7 +332309,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -266246,7 +332366,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -266483,6 +332603,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -266599,7 +332780,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -266642,7 +332823,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -266663,6 +332844,126 @@ "Staff" ] }, + "/ed-fi/staffLeaveEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeaveEventCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffLeaveEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffLeaveEventCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeaveEventCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffLeaveEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffLeaveEventCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -266698,7 +332999,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -266730,15 +333031,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -266765,7 +333057,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -266822,7 +333114,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -267131,6 +333423,72 @@ "staffLeaveEventCategoryDescriptor" ], "type": "object" + }, + "EdFi_StaffLeave_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffLeave_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "staffLeaveEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "staffLeaveEventCategoryDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffLeave_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -267247,7 +333605,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -267290,7 +333648,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -267311,6 +333669,126 @@ "Staff" ] }, + "/ed-fi/staffLeaves/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeavesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffLeaves" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffLeaves/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeavesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffLeaves" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffLeaves/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -267346,7 +333824,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -267378,15 +333856,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -267413,7 +333882,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -267470,7 +333939,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -267816,6 +334285,82 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -267943,7 +334488,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -267986,7 +334531,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -268010,6 +334555,132 @@ "SectionsAndPrograms" ] }, + "/ed-fi/staffProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/staffProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -268045,7 +334716,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -268077,15 +334748,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -268112,7 +334774,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -268169,7 +334831,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -268667,6 +335329,72 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffSchoolAssociation_TrackedChangeKey": { + "properties": { + "programAssignmentDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "programAssignmentDescriptor", + "schoolId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -268776,7 +335504,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -268819,7 +335547,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -268842,6 +335570,130 @@ "SectionsAndPrograms" ] }, + "/ed-fi/staffSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSchoolAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffSchoolAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffSchoolAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSchoolAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffSchoolAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/staffSchoolAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -268877,7 +335729,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -268909,15 +335761,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -268944,7 +335787,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -269001,7 +335844,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -269453,6 +336296,92 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffSectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffSectionAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffSectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -269626,7 +336555,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -269669,7 +336598,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -269693,6 +336622,132 @@ "SectionsAndPrograms" ] }, + "/ed-fi/staffSectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSectionAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffSectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffSectionAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSectionAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffSectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/staffSectionAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -269728,7 +336783,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -269760,15 +336815,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -269795,7 +336841,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -269852,7 +336898,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -270122,6 +337168,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffToCandidateRelationshipDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffToCandidateRelationshipDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffToCandidateRelationshipDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffToCandidateRelationshipDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffToCandidateRelationshipDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffToCandidateRelationshipDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -270238,7 +337345,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -270281,7 +337388,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -270302,6 +337409,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/staffToCandidateRelationshipDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffToCandidateRelationshipsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffToCandidateRelationshipDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffToCandidateRelationshipDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/staffToCandidateRelationshipDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffToCandidateRelationshipsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffToCandidateRelationshipDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffToCandidateRelationshipDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/staffToCandidateRelationshipDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -270337,7 +337564,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -270369,15 +337596,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -270404,7 +337622,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -270461,7 +337679,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -271907,6 +339125,62 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_Staff_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Staff_TrackedChangeKey": { + "properties": { + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_Staff_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -272142,7 +339416,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -272185,7 +339459,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -272216,6 +339490,146 @@ "SectionsAndPrograms" ] }, + "/ed-fi/staffs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffs" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffs/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffs" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/staffs/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -272251,7 +339665,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -272283,15 +339697,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -272318,7 +339723,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -272375,7 +339780,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -272725,6 +340130,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StateAbbreviationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StateAbbreviationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StateAbbreviationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -272841,7 +340307,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -272884,7 +340350,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -272932,6 +340398,180 @@ "StudentTranscript" ] }, + "/ed-fi/stateAbbreviationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStateAbbreviationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "stateAbbreviationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Credential", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/stateAbbreviationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStateAbbreviationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "stateAbbreviationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Credential", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/stateAbbreviationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -272967,7 +340607,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -272999,15 +340639,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -273034,7 +340665,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -273091,7 +340722,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -274491,6 +342122,62 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_StateEducationAgency_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StateEducationAgency_TrackedChangeKey": { + "properties": { + "stateEducationAgencyId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "stateEducationAgencyId" + ], + "type": "object" + }, + "EdFi_StateEducationAgency_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -274607,7 +342294,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -274650,7 +342337,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -274672,6 +342359,128 @@ "Staff" ] }, + "/ed-fi/stateEducationAgencies/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStateEducationAgenciesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "stateEducationAgencies" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, + "/ed-fi/stateEducationAgencies/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStateEducationAgenciesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "stateEducationAgencies" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, "/ed-fi/stateEducationAgencies/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -274707,7 +342516,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -274739,15 +342548,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -274774,7 +342574,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -274831,7 +342631,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -276687,6 +344487,77 @@ "reportCardReference" ], "type": "object" + }, + "EdFi_StudentAcademicRecord_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAcademicRecord_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "schoolYear", + "studentUniqueId", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_StudentAcademicRecord_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -276904,7 +344775,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -276947,7 +344818,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -276972,6 +344843,134 @@ "StudentTranscript" ] }, + "/ed-fi/studentAcademicRecords/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAcademicRecordsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentAcademicRecords" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/studentAcademicRecords/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAcademicRecordsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentAcademicRecords" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/studentAcademicRecords/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -277007,7 +345006,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -277039,15 +345038,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -277074,7 +345064,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -277131,7 +345121,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -277571,6 +345561,88 @@ "studentAssessmentIdentifier" ], "type": "object" + }, + "EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "educationOrganizationAssociationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentAssessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "educationOrganizationAssociationTypeDescriptor", + "educationOrganizationId", + "namespace", + "studentAssessmentIdentifier", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -277701,7 +345773,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -277744,7 +345816,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -277764,6 +345836,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/studentAssessmentEducationOrganizationAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentEducationOrganizationAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentAssessmentEducationOrganizationAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/studentAssessmentEducationOrganizationAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentEducationOrganizationAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentAssessmentEducationOrganizationAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/studentAssessmentEducationOrganizationAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -277799,7 +345989,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -277831,15 +346021,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -277866,7 +346047,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -277923,7 +346104,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -278364,6 +346545,93 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKey": { + "properties": { + "administrationIdentifier": { + "maxLength": 255, + "type": "string" + }, + "assessmentBatteryPartName": { + "maxLength": 65, + "type": "string" + }, + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "assigningEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "administrationIdentifier", + "assessmentBatteryPartName", + "assessmentIdentifier", + "assigningEducationOrganizationId", + "educationOrganizationId", + "namespace", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -278495,7 +346763,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -278538,7 +346806,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -278559,6 +346827,126 @@ "AssessmentRegistration" ] }, + "/ed-fi/studentAssessmentRegistrationBatteryPartAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentRegistrationBatteryPartAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentAssessmentRegistrationBatteryPartAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/studentAssessmentRegistrationBatteryPartAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentRegistrationBatteryPartAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentAssessmentRegistrationBatteryPartAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, "/ed-fi/studentAssessmentRegistrationBatteryPartAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -278594,7 +346982,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -278626,15 +347014,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -278661,7 +347040,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -278718,7 +347097,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -279398,6 +347777,88 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentAssessmentRegistration_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAssessmentRegistration_TrackedChangeKey": { + "properties": { + "administrationIdentifier": { + "maxLength": 255, + "type": "string" + }, + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "assigningEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "administrationIdentifier", + "assessmentIdentifier", + "assigningEducationOrganizationId", + "educationOrganizationId", + "namespace", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentAssessmentRegistration_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -279597,7 +348058,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -279640,7 +348101,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -279661,6 +348122,126 @@ "AssessmentRegistration" ] }, + "/ed-fi/studentAssessmentRegistrations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentRegistrationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentAssessmentRegistrations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/studentAssessmentRegistrations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentRegistrationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentAssessmentRegistrations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, "/ed-fi/studentAssessmentRegistrations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -279696,7 +348277,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -279728,15 +348309,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -279763,7 +348335,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -279820,7 +348392,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -281488,6 +350060,78 @@ "objectiveAssessmentReference" ], "type": "object" + }, + "EdFi_StudentAssessment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAssessment_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentAssessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "namespace", + "studentAssessmentIdentifier", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentAssessment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -281734,7 +350378,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -281777,7 +350421,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -281799,6 +350443,128 @@ "StudentAssessment" ] }, + "/ed-fi/studentAssessments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentAssessments" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/studentAssessments/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentAssessments" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, "/ed-fi/studentAssessments/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -281834,7 +350600,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -281866,15 +350632,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -281901,7 +350658,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -281958,7 +350715,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -282761,6 +351518,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentCteProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCteProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentCteProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -282932,7 +351770,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -282975,7 +351813,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -282996,6 +351834,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentCTEProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCTEProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentCTEProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentCTEProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCTEProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentCTEProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentCTEProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -283031,7 +351989,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -283063,15 +352021,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -283098,7 +352047,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -283155,7 +352104,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -283432,6 +352381,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StudentCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StudentCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -283548,7 +352558,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -283591,7 +352601,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -283614,6 +352624,130 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/studentCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCharacteristicsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "RecruitingAndStaffing", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentCharacteristicDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCharacteristicsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "RecruitingAndStaffing", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/studentCharacteristicDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -283649,7 +352783,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -283681,15 +352815,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -283716,7 +352841,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -283773,7 +352898,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -284195,6 +353320,77 @@ "sectionReference" ], "type": "object" + }, + "EdFi_StudentCohortAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCohortAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "cohortIdentifier": { + "maxLength": 36, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "cohortIdentifier", + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentCohortAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -284304,7 +353500,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -284347,7 +353543,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -284369,6 +353565,128 @@ "StudentCohort" ] }, + "/ed-fi/studentCohortAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCohortAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentCohortAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/studentCohortAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCohortAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentCohortAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/studentCohortAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -284404,7 +353722,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -284436,15 +353754,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -284471,7 +353780,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -284528,7 +353837,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -285201,6 +354510,97 @@ "studentSectionAssociationReference" ], "type": "object" + }, + "EdFi_StudentCompetencyObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCompetencyObjective_TrackedChangeKey": { + "properties": { + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "type": "string" + }, + "gradingPeriodSchoolId": { + "format": "int64", + "type": "integer" + }, + "gradingPeriodSchoolYear": { + "format": "int32", + "type": "integer" + }, + "objective": { + "maxLength": 60, + "type": "string" + }, + "objectiveEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "objectiveGradeLevelDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolId", + "gradingPeriodSchoolYear", + "objective", + "objectiveEducationOrganizationId", + "objectiveGradeLevelDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentCompetencyObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -285359,7 +354759,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -285402,7 +354802,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -285424,6 +354824,128 @@ "ReportCard" ] }, + "/ed-fi/studentCompetencyObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCompetencyObjectivesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentCompetencyObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/studentCompetencyObjectives/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCompetencyObjectivesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentCompetencyObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, "/ed-fi/studentCompetencyObjectives/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -285459,7 +354981,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -285491,15 +355013,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -285526,7 +355039,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -285583,7 +355096,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -285980,6 +355493,67 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentContactAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentContactAssociation_TrackedChangeKey": { + "properties": { + "contactUniqueId": { + "maxLength": 32, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "contactUniqueId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentContactAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -286119,7 +355693,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -286162,7 +355736,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -286183,6 +355757,126 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/studentContactAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentContactAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentContactAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentContactAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentContactAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentContactAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/studentContactAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -286218,7 +355912,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -286250,15 +355944,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -286285,7 +355970,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -286342,7 +356027,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -287541,6 +357226,67 @@ ], "type": "object" }, + "EdFi_StudentDemographic_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentDemographic_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentDemographic_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentDemographic_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDemographic_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDemographic_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_StudentDemographic_TribalAffiliation": { "properties": { "tribalAffiliationDescriptor": { @@ -287695,7 +357441,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -287738,7 +357484,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -287759,6 +357505,126 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/studentDemographics/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDemographicsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDemographic_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentDemographics" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentDemographics/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDemographicsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDemographic_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentDemographics" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/studentDemographics/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -287794,7 +357660,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -287826,15 +357692,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -287861,7 +357718,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -287918,7 +357775,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -289031,6 +358888,67 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "EdFi_StudentDirectory_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentDirectory_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentDirectory_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentDirectory_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDirectory_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDirectory_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -289111,7 +359029,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -289154,7 +359072,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -289175,6 +359093,126 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/studentDirectories/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDirectoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDirectory_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentDirectories" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentDirectories/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDirectoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDirectory_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentDirectories" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/studentDirectories/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -289210,7 +359248,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -289242,15 +359280,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -289277,7 +359306,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -289334,7 +359363,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -289720,6 +359749,77 @@ ], "type": "object" }, + "EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey": { + "properties": { + "behaviorDescriptor": { + "maxLength": 306, + "type": "string" + }, + "incidentIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "behaviorDescriptor", + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_StudentDisciplineIncidentBehaviorAssociation_Weapon": { "properties": { "weaponDescriptor": { @@ -289841,7 +359941,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -289884,7 +359984,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -289905,6 +360005,126 @@ "Discipline" ] }, + "/ed-fi/studentDisciplineIncidentBehaviorAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentBehaviorAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentDisciplineIncidentBehaviorAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/studentDisciplineIncidentBehaviorAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentBehaviorAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentDisciplineIncidentBehaviorAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/studentDisciplineIncidentBehaviorAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -289940,7 +360160,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -289972,15 +360192,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -290007,7 +360218,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -290064,7 +360275,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -290376,6 +360587,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey": { + "properties": { + "incidentIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -290466,7 +360743,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -290509,7 +360786,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -290530,6 +360807,126 @@ "Discipline" ] }, + "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentNonOffenderAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentDisciplineIncidentNonOffenderAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentNonOffenderAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentDisciplineIncidentNonOffenderAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -290565,7 +360962,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -290597,15 +360994,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -290632,7 +361020,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -290689,7 +361077,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -290969,6 +361357,67 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -291049,7 +361498,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -291092,7 +361541,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -291113,6 +361562,126 @@ "AssessmentRegistration" ] }, + "/ed-fi/studentEducationOrganizationAssessmentAccommodations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationAssessmentAccommodationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentEducationOrganizationAssessmentAccommodations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/studentEducationOrganizationAssessmentAccommodations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationAssessmentAccommodationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentEducationOrganizationAssessmentAccommodations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, "/ed-fi/studentEducationOrganizationAssessmentAccommodations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -291148,7 +361717,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -291180,15 +361749,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -291215,7 +361775,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -291272,7 +361832,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -292113,6 +362673,67 @@ "indicator" ], "type": "object" + }, + "EdFi_StudentEducationOrganizationAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -292273,7 +362894,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -292316,7 +362937,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -292338,6 +362959,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/studentEducationOrganizationAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentEducationOrganizationAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentEducationOrganizationAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentEducationOrganizationAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/studentEducationOrganizationAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -292373,7 +363116,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -292405,15 +363148,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -292440,7 +363174,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -292497,7 +363231,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -292851,6 +363585,77 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "responsibilityDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "responsibilityDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -292960,7 +363765,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -293003,7 +363808,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -293024,6 +363829,126 @@ "Enrollment" ] }, + "/ed-fi/studentEducationOrganizationResponsibilityAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationResponsibilityAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentEducationOrganizationResponsibilityAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/studentEducationOrganizationResponsibilityAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationResponsibilityAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentEducationOrganizationResponsibilityAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/studentEducationOrganizationResponsibilityAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -293059,7 +363984,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -293091,15 +364016,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -293126,7 +364042,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -293183,7 +364099,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -293661,6 +364577,73 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentGradebookEntry_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentGradebookEntry_TrackedChangeKey": { + "properties": { + "gradebookEntryIdentifier": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "gradebookEntryIdentifier", + "namespace", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentGradebookEntry_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -293849,7 +364832,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -293892,7 +364875,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -293914,6 +364897,128 @@ "Gradebook" ] }, + "/ed-fi/studentGradebookEntries/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentGradebookEntriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentGradebookEntries" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/studentGradebookEntries/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentGradebookEntriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentGradebookEntries" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, "/ed-fi/studentGradebookEntries/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -293949,7 +365054,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -293981,15 +365086,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -294016,7 +365112,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -294073,7 +365169,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -294666,6 +365762,67 @@ "immunizationTypeDescriptor" ], "type": "object" + }, + "EdFi_StudentHealth_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentHealth_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentHealth_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -294773,7 +365930,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -294816,7 +365973,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -294837,6 +365994,126 @@ "StudentHealth" ] }, + "/ed-fi/studentHealths/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHealthsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentHealths" + ] + }, + "x-Ed-Fi-domains": [ + "StudentHealth" + ] + }, + "/ed-fi/studentHealths/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHealthsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentHealths" + ] + }, + "x-Ed-Fi-domains": [ + "StudentHealth" + ] + }, "/ed-fi/studentHealths/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -294872,7 +366149,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -294904,15 +366181,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -294939,7 +366207,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -294996,7 +366264,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -295686,6 +366954,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentHomelessProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentHomelessProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentHomelessProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -295857,7 +367206,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -295900,7 +367249,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -295921,6 +367270,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentHomelessProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHomelessProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentHomelessProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentHomelessProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHomelessProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentHomelessProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentHomelessProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -295956,7 +367425,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -295988,15 +367457,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -296023,7 +367483,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -296080,7 +367540,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -296436,6 +367896,72 @@ "studentIdentificationSystemDescriptor" ], "type": "object" + }, + "EdFi_StudentIdentificationCode_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentIdentificationCode_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentIdentificationSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentIdentificationSystemDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentIdentificationCode_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationCode_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -296544,7 +368070,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -296587,7 +368113,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -296608,6 +368134,126 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/studentIdentificationCodes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIdentificationCodesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationCode_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentIdentificationCodes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIdentificationCodesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationCode_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/studentIdentificationCodes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -296643,7 +368289,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -296675,15 +368321,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -296710,7 +368347,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -296767,7 +368404,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -296994,6 +368631,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StudentIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -297110,7 +368808,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -297153,7 +368851,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -297176,6 +368874,130 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/studentIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIdentificationSystemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentIdentificationSystemDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIdentificationSystemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/studentIdentificationSystemDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -297211,7 +369033,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -297243,15 +369065,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -297278,7 +369091,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -297335,7 +369148,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -297822,6 +369635,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentInterventionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentInterventionAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionIdentificationCode": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionIdentificationCode", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentInterventionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -297950,7 +369829,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -297993,7 +369872,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -298015,6 +369894,128 @@ "StudentCohort" ] }, + "/ed-fi/studentInterventionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentInterventionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/studentInterventionAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentInterventionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/studentInterventionAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -298050,7 +370051,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -298082,15 +370083,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -298117,7 +370109,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -298174,7 +370166,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -298594,6 +370586,82 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentInterventionAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "interventionIdentificationCode": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "educationOrganizationId", + "eventDate", + "interventionIdentificationCode", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentInterventionAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -298740,7 +370808,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -298783,7 +370851,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -298804,6 +370872,126 @@ "Intervention" ] }, + "/ed-fi/studentInterventionAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAttendanceEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentInterventionAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/studentInterventionAttendanceEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAttendanceEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentInterventionAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, "/ed-fi/studentInterventionAttendanceEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -298839,7 +371027,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -298871,15 +371059,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -298906,7 +371085,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -298963,7 +371142,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -299805,6 +371984,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -299968,7 +372228,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -300011,7 +372271,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -300032,6 +372292,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentLanguageInstructionProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentLanguageInstructionProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentLanguageInstructionProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentLanguageInstructionProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentLanguageInstructionProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentLanguageInstructionProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentLanguageInstructionProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -300067,7 +372447,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -300099,15 +372479,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -300134,7 +372505,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -300191,7 +372562,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -301037,6 +373408,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -301263,7 +373715,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -301306,7 +373758,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -301327,6 +373779,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentMigrantEducationProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentMigrantEducationProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentMigrantEducationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentMigrantEducationProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentMigrantEducationProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentMigrantEducationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentMigrantEducationProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -301362,7 +373934,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -301394,15 +373966,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -301429,7 +373992,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -301486,7 +374049,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -302264,6 +374827,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -302437,7 +375081,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -302480,7 +375124,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -302501,6 +375145,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentNeglectedOrDelinquentProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentNeglectedOrDelinquentProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentNeglectedOrDelinquentProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentNeglectedOrDelinquentProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -302536,7 +375300,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -302568,15 +375332,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -302603,7 +375358,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -302660,7 +375415,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -303174,6 +375929,84 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentPathMilestoneStatus_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentPathMilestoneStatus_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentPathMilestoneStatus_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "pathMilestoneName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + }, + "pathMilestoneTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "pathName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "pathMilestoneName", + "pathMilestoneTypeDescriptor", + "pathName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentPathMilestoneStatus_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentPathMilestoneStatus_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentPathMilestoneStatus_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -303305,7 +376138,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -303348,7 +376181,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -303369,6 +376202,126 @@ "Path" ] }, + "/ed-fi/studentPathMilestoneStatuses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentPathMilestoneStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentPathMilestoneStatus_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentPathMilestoneStatuses" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/studentPathMilestoneStatuses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentPathMilestoneStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentPathMilestoneStatus_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentPathMilestoneStatuses" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/studentPathMilestoneStatuses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -303404,7 +376357,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -303436,15 +376389,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -303471,7 +376415,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -303528,7 +376472,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -304021,6 +376965,79 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentPathPhaseStatus_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentPathPhaseStatus_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentPathPhaseStatus_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "pathName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + }, + "pathPhaseName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "pathName", + "pathPhaseName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentPathPhaseStatus_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentPathPhaseStatus_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentPathPhaseStatus_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -304131,7 +377148,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -304174,7 +377191,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -304195,6 +377212,126 @@ "Path" ] }, + "/ed-fi/studentPathPhaseStatuses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentPathPhaseStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentPathPhaseStatus_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentPathPhaseStatuses" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/studentPathPhaseStatuses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentPathPhaseStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentPathPhaseStatus_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentPathPhaseStatuses" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/studentPathPhaseStatuses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -304230,7 +377367,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -304262,15 +377399,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -304297,7 +377425,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -304354,7 +377482,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -304689,6 +377817,73 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentPath_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentPath_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentPath_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "pathName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "pathName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentPath_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentPath_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentPath_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -304780,7 +377975,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -304823,7 +378018,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -304844,6 +378039,126 @@ "Path" ] }, + "/ed-fi/studentPaths/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentPathsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentPath_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentPaths" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/studentPaths/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentPathsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentPath_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentPaths" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/studentPaths/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -304879,7 +378194,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -304911,15 +378226,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -304946,7 +378252,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -305003,7 +378309,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -305626,6 +378932,87 @@ "serviceDescriptor" ], "type": "object" + }, + "EdFi_StudentProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -305772,7 +379159,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -305815,7 +379202,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -305842,6 +379229,138 @@ "SectionsAndPrograms" ] }, + "/ed-fi/studentProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/studentProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -305877,7 +379396,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -305909,15 +379428,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -305944,7 +379454,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -306001,7 +379511,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -306506,6 +380016,92 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentProgramAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentProgramAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "educationOrganizationId", + "eventDate", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentProgramAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -306672,7 +380268,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -306715,7 +380311,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -306738,6 +380334,130 @@ "StudentAttendance" ] }, + "/ed-fi/studentProgramAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAttendanceEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentProgramAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentProgramAttendanceEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAttendanceEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentProgramAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, "/ed-fi/studentProgramAttendanceEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -306773,7 +380493,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -306805,15 +380525,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -306840,7 +380551,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -306897,7 +380608,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -307929,6 +381640,97 @@ "programEvaluationObjectiveReference" ], "type": "object" + }, + "EdFi_StudentProgramEvaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentProgramEvaluation_TrackedChangeKey": { + "properties": { + "evaluationDate": { + "format": "date", + "type": "string" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "evaluationDate", + "programEducationOrganizationId", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentProgramEvaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -308125,7 +381927,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -308168,7 +381970,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -308190,6 +381992,128 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/studentProgramEvaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramEvaluationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentProgramEvaluations" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/studentProgramEvaluations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramEvaluationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentProgramEvaluations" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/studentProgramEvaluations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -308225,7 +382149,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -308257,15 +382181,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -308292,7 +382207,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -308349,7 +382264,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -309362,6 +383277,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSchoolAssociation_TrackedChangeKey": { + "properties": { + "entryDate": { + "format": "date", + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "entryDate", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -309658,7 +383639,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -309701,7 +383682,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -309726,6 +383707,134 @@ "SectionsAndPrograms" ] }, + "/ed-fi/studentSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSchoolAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentSchoolAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSchoolAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/studentSchoolAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -309761,7 +383870,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -309793,15 +383902,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -309828,7 +383928,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -309885,7 +383985,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -310527,6 +384627,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSchoolAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "eventDate", + "schoolId", + "schoolYear", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSchoolAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -310699,7 +384880,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -310742,7 +384923,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -310765,6 +384946,130 @@ "StudentAttendance" ] }, + "/ed-fi/studentSchoolAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAttendanceEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSchoolAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentSchoolAttendanceEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAttendanceEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSchoolAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, "/ed-fi/studentSchoolAttendanceEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -310800,7 +385105,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -310832,15 +385137,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -310867,7 +385163,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -310924,7 +385220,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -311618,6 +385914,87 @@ "schoolFoodServiceProgramServiceDescriptor" ], "type": "object" + }, + "EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -311772,7 +386149,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -311815,7 +386192,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -311836,6 +386213,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentSchoolFoodServiceProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolFoodServiceProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSchoolFoodServiceProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentSchoolFoodServiceProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolFoodServiceProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSchoolFoodServiceProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentSchoolFoodServiceProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -311871,7 +386368,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -311903,15 +386400,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -311938,7 +386426,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -311995,7 +386483,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -312646,6 +387134,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSection504ProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSection504ProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSection504ProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -312835,7 +387404,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -312878,7 +387447,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -312899,6 +387468,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentSection504ProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSection504ProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSection504ProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentSection504ProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSection504ProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSection504ProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentSection504ProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -312934,7 +387623,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -312966,15 +387655,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -313001,7 +387681,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -313058,7 +387738,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -313765,6 +388445,92 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSectionAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -313982,7 +388748,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -314025,7 +388791,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -314054,6 +388820,142 @@ "SectionsAndPrograms" ] }, + "/ed-fi/studentSectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentSectionAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/studentSectionAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -314089,7 +388991,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -314121,15 +389023,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -314156,7 +389049,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -314213,7 +389106,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -314881,6 +389774,97 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSectionAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSectionAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "eventDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSectionAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -315073,7 +390057,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -315116,7 +390100,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -315139,6 +390123,130 @@ "StudentAttendance" ] }, + "/ed-fi/studentSectionAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAttendanceEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSectionAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentSectionAttendanceEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAttendanceEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSectionAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, "/ed-fi/studentSectionAttendanceEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -315174,7 +390282,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -315206,15 +390314,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -315241,7 +390340,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -315298,7 +390397,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -316642,6 +391741,87 @@ "specialEducationProgramServiceDescriptor" ], "type": "object" + }, + "EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -316937,7 +392117,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -316980,7 +392160,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -317002,6 +392182,128 @@ "SpecialEducation" ] }, + "/ed-fi/studentSpecialEducationProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSpecialEducationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation" + ] + }, + "/ed-fi/studentSpecialEducationProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSpecialEducationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation" + ] + }, "/ed-fi/studentSpecialEducationProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -317037,7 +392339,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -317069,15 +392371,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -317104,7 +392397,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -317161,7 +392454,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -317935,6 +393228,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey": { + "properties": { + "consentToEvaluationReceivedDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "consentToEvaluationReceivedDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -318188,7 +393562,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -318231,7 +393605,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -318252,6 +393626,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramEligibilityAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSpecialEducationProgramEligibilityAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramEligibilityAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSpecialEducationProgramEligibilityAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -318287,7 +393781,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -318319,15 +393813,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -318354,7 +393839,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -318411,7 +393896,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -319163,6 +394648,87 @@ "titleIPartAProgramServiceDescriptor" ], "type": "object" + }, + "EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -319318,7 +394884,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -319361,7 +394927,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -319382,6 +394948,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentTitleIPartAProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTitleIPartAProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentTitleIPartAProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentTitleIPartAProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTitleIPartAProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentTitleIPartAProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentTitleIPartAProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -319417,7 +395103,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -319449,15 +395135,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -319484,7 +395161,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -319541,7 +395218,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -320041,6 +395718,67 @@ ], "type": "object" }, + "EdFi_StudentTransportation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentTransportation_TrackedChangeKey": { + "properties": { + "studentUniqueId": { + "maxLength": 32, + "type": "string" + }, + "transportationEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "studentUniqueId", + "transportationEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_StudentTransportation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_StudentTransportation_TravelDayofWeek": { "properties": { "travelDayofWeekDescriptor": { @@ -320173,7 +395911,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -320216,7 +395954,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -320237,6 +395975,126 @@ "Enrollment" ] }, + "/ed-fi/studentTransportations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTransportationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentTransportations" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/studentTransportations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTransportationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentTransportations" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/studentTransportations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -320272,7 +396130,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -320304,15 +396162,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -320339,7 +396188,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -320396,7 +396245,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -321265,6 +397114,62 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_Student_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Student_TrackedChangeKey": { + "properties": { + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_Student_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -321499,7 +397404,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -321542,7 +397447,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -321582,6 +397487,164 @@ "StudentTranscript" ] }, + "/ed-fi/students/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "students" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "Enrollment", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/students/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "students" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "Enrollment", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/students/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -321617,7 +397680,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -321649,15 +397712,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -321684,7 +397738,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -321741,7 +397795,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -322074,6 +398128,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SubmissionStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SubmissionStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SubmissionStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -322190,7 +398305,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -322233,7 +398348,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -322255,6 +398370,128 @@ "Gradebook" ] }, + "/ed-fi/submissionStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSubmissionStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "submissionStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/submissionStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSubmissionStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "submissionStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, "/ed-fi/submissionStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -322290,7 +398527,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -322322,15 +398559,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -322357,7 +398585,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -322414,7 +398642,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -322643,6 +398871,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -322759,7 +399048,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -322802,7 +399091,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -322824,6 +399113,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/supporterMilitaryConnectionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSupporterMilitaryConnectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "supporterMilitaryConnectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/supporterMilitaryConnectionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSupporterMilitaryConnectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "supporterMilitaryConnectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/supporterMilitaryConnectionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -322859,7 +399270,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -322891,15 +399302,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -322926,7 +399328,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -322983,7 +399385,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -323211,6 +399613,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SurveyCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SurveyCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -323327,7 +399790,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -323370,7 +399833,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -323391,6 +399854,126 @@ "Survey" ] }, + "/ed-fi/surveyCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -323426,7 +400009,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -323458,15 +400041,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -323493,7 +400067,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -323550,7 +400124,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -323831,6 +400405,78 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_SurveyCourseAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyCourseAssociation_TrackedChangeKey": { + "properties": { + "courseCode": { + "maxLength": 120, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "courseCode", + "educationOrganizationId", + "namespace", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyCourseAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -323932,7 +400578,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -323975,7 +400621,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -323996,6 +400642,126 @@ "Survey" ] }, + "/ed-fi/surveyCourseAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCourseAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyCourseAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyCourseAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCourseAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyCourseAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyCourseAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -324031,7 +400797,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -324063,15 +400829,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -324098,7 +400855,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -324155,7 +400912,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -324374,6 +401131,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SurveyLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SurveyLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -324490,7 +401308,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -324533,7 +401351,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -324554,6 +401372,126 @@ "Survey" ] }, + "/ed-fi/surveyLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -324589,7 +401527,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -324621,15 +401559,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -324656,7 +401585,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -324713,7 +401642,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -325013,6 +401942,83 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_SurveyProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyProgramAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "namespace", + "programName", + "programTypeDescriptor", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -325124,7 +402130,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -325167,7 +402173,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -325188,6 +402194,126 @@ "Survey" ] }, + "/ed-fi/surveyProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -325223,7 +402349,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -325255,15 +402381,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -325290,7 +402407,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -325347,7 +402464,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -325939,6 +403056,78 @@ "surveyQuestionResponseValueIdentifier" ], "type": "object" + }, + "EdFi_SurveyQuestionResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyQuestionResponse_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "questionCode": { + "maxLength": 120, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "namespace", + "questionCode", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyQuestionResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -326057,7 +403246,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -326100,7 +403289,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -326121,6 +403310,126 @@ "Survey" ] }, + "/ed-fi/surveyQuestionResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyQuestionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyQuestionResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyQuestionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyQuestionResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -326156,7 +403465,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -326188,15 +403497,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -326223,7 +403523,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -326280,7 +403580,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -326826,6 +404126,73 @@ "sortOrder" ], "type": "object" + }, + "EdFi_SurveyQuestion_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyQuestion_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "questionCode": { + "maxLength": 120, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "namespace", + "questionCode", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyQuestion_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -326945,7 +404312,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -326988,7 +404355,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -327009,6 +404376,126 @@ "Survey" ] }, + "/ed-fi/surveyQuestions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyQuestions" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyQuestions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyQuestions" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyQuestions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -327044,7 +404531,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -327076,15 +404563,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -327111,7 +404589,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -327168,7 +404646,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -327450,6 +404928,78 @@ "surveyResponseIdentifier" ], "type": "object" + }, + "EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -327551,7 +405101,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -327594,7 +405144,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -327615,6 +405165,126 @@ "Survey" ] }, + "/ed-fi/surveyResponseEducationOrganizationTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseEducationOrganizationTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponseEducationOrganizationTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseEducationOrganizationTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponseEducationOrganizationTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -327650,7 +405320,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -327682,15 +405352,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -327717,7 +405378,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -327774,7 +405435,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -328066,6 +405727,83 @@ "surveyResponseIdentifier" ], "type": "object" + }, + "EdFi_SurveyResponsePersonTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponsePersonTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponsePersonTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "namespace", + "personId", + "sourceSystemDescriptor", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponsePersonTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponsePersonTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponsePersonTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -328177,7 +405915,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -328220,7 +405958,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -328241,6 +405979,126 @@ "Survey" ] }, + "/ed-fi/surveyResponsePersonTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponsePersonTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponsePersonTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponsePersonTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponsePersonTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponsePersonTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponsePersonTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponsePersonTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponsePersonTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -328276,7 +406134,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -328308,15 +406166,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -328343,7 +406192,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -328400,7 +406249,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -328675,6 +406524,78 @@ "surveyResponseIdentifier" ], "type": "object" + }, + "EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "namespace", + "staffUniqueId", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -328776,7 +406697,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -328819,7 +406740,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -328840,6 +406761,126 @@ "Survey" ] }, + "/ed-fi/surveyResponseStaffTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseStaffTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponseStaffTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseStaffTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponseStaffTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -328875,7 +406916,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -328907,15 +406948,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -328942,7 +406974,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -328999,7 +407031,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -329519,6 +407551,73 @@ "surveyLevelDescriptor" ], "type": "object" + }, + "EdFi_SurveyResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponse_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -329706,7 +407805,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -329749,7 +407848,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -329770,6 +407869,126 @@ "Survey" ] }, + "/ed-fi/surveyResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -329805,7 +408024,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -329837,15 +408056,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -329872,7 +408082,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -329929,7 +408139,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -330543,6 +408753,137 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionAggregateResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAggregateResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionAggregateResponse_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationDate": { + "format": "date-time", + "type": "string" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationDate", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "namespace", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "surveyIdentifier", + "surveySectionTitle", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_SurveySectionAggregateResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAggregateResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAggregateResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -330767,7 +409108,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -330810,7 +409151,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -330831,6 +409172,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/surveySectionAggregateResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionAggregateResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionAggregateResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionAggregateResponses" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/surveySectionAggregateResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionAggregateResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionAggregateResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionAggregateResponses" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/surveySectionAggregateResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -330866,7 +409327,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -330898,15 +409359,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -330933,7 +409385,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -330990,7 +409442,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -331398,6 +409850,93 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_SurveySectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionAssociation_TrackedChangeKey": { + "properties": { + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "localCourseCode", + "namespace", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveySectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -331529,7 +410068,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -331572,7 +410111,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -331593,6 +410132,126 @@ "Survey" ] }, + "/ed-fi/surveySectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -331628,7 +410287,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -331660,15 +410319,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -331695,7 +410345,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -331752,7 +410402,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -332073,6 +410723,83 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -332184,7 +410911,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -332227,7 +410954,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -332248,6 +410975,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseEducationOrganizationTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseEducationOrganizationTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -332283,7 +411130,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -332315,15 +411162,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -332350,7 +411188,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -332407,7 +411245,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -332735,6 +411573,88 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponsePersonTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponsePersonTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponsePersonTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "personId", + "sourceSystemDescriptor", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponsePersonTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponsePersonTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponsePersonTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -332856,7 +411776,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -332899,7 +411819,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -332920,6 +411840,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponsePersonTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponsePersonTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponsePersonTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponsePersonTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponsePersonTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponsePersonTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponsePersonTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponsePersonTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponsePersonTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -332955,7 +411995,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -332987,15 +412027,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -333022,7 +412053,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -333079,7 +412110,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -333390,6 +412421,83 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "staffUniqueId", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -333501,7 +412609,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -333544,7 +412652,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -333565,6 +412673,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponseStaffTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseStaffTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponseStaffTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseStaffTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponseStaffTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -333600,7 +412828,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -333632,15 +412860,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -333667,7 +412886,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -333724,7 +412943,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -334058,6 +413277,78 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponse_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -334168,7 +413459,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -334211,7 +413502,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -334232,6 +413523,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -334267,7 +413678,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -334299,15 +413710,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -334334,7 +413736,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -334391,7 +413793,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -334764,6 +414166,73 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySection_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySection_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySection_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -334949,7 +414418,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -334992,7 +414461,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -335013,6 +414482,126 @@ "Survey" ] }, + "/ed-fi/surveySections/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySections" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySections/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySections" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySections/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -335048,7 +414637,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -335080,15 +414669,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -335115,7 +414695,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -335172,7 +414752,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -335613,6 +415193,68 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_Survey_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Survey_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_Survey_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -335760,7 +415402,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -335803,7 +415445,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -335824,6 +415466,126 @@ "Survey" ] }, + "/ed-fi/surveys/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveysDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveys" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveys/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveysKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveys" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveys/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -335859,7 +415621,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -335891,15 +415653,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -335926,7 +415679,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -335983,7 +415736,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -336229,6 +415982,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TeachingCredentialBasisDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -336345,7 +416159,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -336388,7 +416202,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -336410,6 +416224,128 @@ "Staff" ] }, + "/ed-fi/teachingCredentialBasisDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialBasesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "teachingCredentialBasisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, + "/ed-fi/teachingCredentialBasisDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialBasesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "teachingCredentialBasisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, "/ed-fi/teachingCredentialBasisDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -336445,7 +416381,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -336477,15 +416413,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -336512,7 +416439,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -336569,7 +416496,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -336798,6 +416725,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TeachingCredentialDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TeachingCredentialDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TeachingCredentialDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -336914,7 +416902,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -336957,7 +416945,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -336979,6 +416967,128 @@ "Staff" ] }, + "/ed-fi/teachingCredentialDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "teachingCredentialDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, + "/ed-fi/teachingCredentialDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "teachingCredentialDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, "/ed-fi/teachingCredentialDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -337014,7 +417124,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -337046,15 +417156,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -337081,7 +417182,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -337138,7 +417239,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -337366,6 +417467,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -337482,7 +417644,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -337525,7 +417687,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -337546,6 +417708,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/technicalSkillsAssessmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTechnicalSkillsAssessmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "technicalSkillsAssessmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/technicalSkillsAssessmentDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTechnicalSkillsAssessmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "technicalSkillsAssessmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/technicalSkillsAssessmentDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -337581,7 +417863,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -337613,15 +417895,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -337648,7 +417921,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -337705,7 +417978,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -337946,6 +418219,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TelephoneNumberTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -338062,7 +418396,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -338105,7 +418439,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -338140,6 +418474,154 @@ "SectionsAndPrograms" ] }, + "/ed-fi/telephoneNumberTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTelephoneNumberTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "telephoneNumberTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Intervention", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/telephoneNumberTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTelephoneNumberTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "telephoneNumberTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Intervention", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/telephoneNumberTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -338175,7 +418657,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -338207,15 +418689,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -338242,7 +418715,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -338299,7 +418772,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -338555,6 +419028,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TermDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TermDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TermDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -338671,7 +419205,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -338714,7 +419248,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -338750,6 +419284,156 @@ "StudentTranscript" ] }, + "/ed-fi/termDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTermsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "termDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "EducatorPreparationProgram", + "Enrollment", + "Graduation", + "PerformanceEvaluation", + "RecruitingAndStaffing", + "SchoolCalendar", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/termDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTermsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "termDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "EducatorPreparationProgram", + "Enrollment", + "Graduation", + "PerformanceEvaluation", + "RecruitingAndStaffing", + "SchoolCalendar", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/termDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -338785,7 +419469,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -338817,15 +419501,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -338852,7 +419527,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -338909,7 +419584,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -339151,6 +419826,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TitleIPartAParticipantDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -339267,7 +420003,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -339310,7 +420046,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -339331,6 +420067,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/titleIPartAParticipantDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAParticipantsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "titleIPartAParticipantDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/titleIPartAParticipantDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAParticipantsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "titleIPartAParticipantDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/titleIPartAParticipantDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -339366,7 +420222,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -339398,15 +420254,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -339433,7 +420280,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -339490,7 +420337,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -339717,6 +420564,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -339833,7 +420741,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -339876,7 +420784,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -339897,6 +420805,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/titleIPartAProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "titleIPartAProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/titleIPartAProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "titleIPartAProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/titleIPartAProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -339932,7 +420960,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -339964,15 +420992,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -339999,7 +421018,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -340056,7 +421075,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -340296,6 +421315,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -340412,7 +421492,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -340455,7 +421535,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -340489,6 +421569,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/titleIPartASchoolDesignationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartASchoolDesignationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "titleIPartASchoolDesignationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/titleIPartASchoolDesignationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartASchoolDesignationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "titleIPartASchoolDesignationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/titleIPartASchoolDesignationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -340524,7 +421750,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -340556,15 +421782,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -340591,7 +421808,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -340648,7 +421865,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -340888,6 +422105,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -341004,7 +422282,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -341047,7 +422325,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -341068,6 +422346,126 @@ "Enrollment" ] }, + "/ed-fi/transportationPublicExpenseEligibilityTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTransportationPublicExpenseEligibilityTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "transportationPublicExpenseEligibilityTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/transportationPublicExpenseEligibilityTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTransportationPublicExpenseEligibilityTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "transportationPublicExpenseEligibilityTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/transportationPublicExpenseEligibilityTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -341103,7 +422501,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -341135,15 +422533,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -341170,7 +422559,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -341227,7 +422616,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -341454,6 +422843,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TransportationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TransportationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TransportationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -341570,7 +423020,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -341613,7 +423063,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -341634,6 +423084,126 @@ "Enrollment" ] }, + "/ed-fi/transportationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTransportationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "transportationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/transportationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTransportationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "transportationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/transportationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -341669,7 +423239,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -341701,15 +423271,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -341736,7 +423297,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -341793,7 +423354,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -342020,6 +423581,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TravelDayofWeekDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TravelDayofWeekDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TravelDayofWeekDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -342136,7 +423758,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -342179,7 +423801,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -342200,6 +423822,126 @@ "Enrollment" ] }, + "/ed-fi/travelDayofWeekDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTravelDayofWeeksDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "travelDayofWeekDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/travelDayofWeekDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTravelDayofWeeksKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "travelDayofWeekDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/travelDayofWeekDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -342235,7 +423977,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -342267,15 +424009,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -342302,7 +424035,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -342359,7 +424092,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -342586,6 +424319,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TravelDirectionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TravelDirectionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TravelDirectionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -342702,7 +424496,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -342745,7 +424539,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -342766,6 +424560,126 @@ "Enrollment" ] }, + "/ed-fi/travelDirectionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTravelDirectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "travelDirectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/travelDirectionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTravelDirectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "travelDirectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/travelDirectionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -342801,7 +424715,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -342833,15 +424747,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -342868,7 +424773,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -342925,7 +424830,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -343164,6 +425069,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TribalAffiliationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TribalAffiliationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TribalAffiliationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -343280,7 +425246,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -343323,7 +425289,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -343356,6 +425322,150 @@ "SectionsAndPrograms" ] }, + "/ed-fi/tribalAffiliationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTribalAffiliationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "tribalAffiliationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Enrollment", + "Finance", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/tribalAffiliationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTribalAffiliationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "tribalAffiliationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Enrollment", + "Finance", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/tribalAffiliationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -343391,7 +425501,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -343423,15 +425533,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -343458,7 +425559,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -343515,7 +425616,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -343777,6 +425878,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_VisaDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_VisaDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_VisaDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -343893,7 +426055,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -343936,7 +426098,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -343980,6 +426142,172 @@ "StudentTranscript" ] }, + "/ed-fi/visaDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getVisasDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "visaDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/visaDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getVisasKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "visaDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/visaDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -344015,7 +426343,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -344047,15 +426375,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -344082,7 +426401,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -344139,7 +426458,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -344389,6 +426708,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_WeaponDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_WeaponDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_WeaponDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -344505,7 +426885,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -344548,7 +426928,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -344569,6 +426949,126 @@ "Discipline" ] }, + "/ed-fi/weaponDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getWeaponsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "weaponDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/weaponDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getWeaponsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "weaponDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/weaponDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -344604,7 +427104,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -344636,15 +427136,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -344671,7 +427162,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -344728,7 +427219,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -344955,6 +427446,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_WithdrawReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_WithdrawReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_WithdrawReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_WithdrawReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_WithdrawReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_WithdrawReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -345071,7 +427623,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -345114,7 +427666,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -345135,6 +427687,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/withdrawReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getWithdrawReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_WithdrawReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "withdrawReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/withdrawReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getWithdrawReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_WithdrawReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "withdrawReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/withdrawReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -345170,7 +427842,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -345202,15 +427874,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -345237,7 +427900,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -345294,7 +427957,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" diff --git a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.0-homograph-api-schema-authoritative.json b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.0-homograph-api-schema-authoritative.json index 0018f9b5d..4003b5f96 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.0-homograph-api-schema-authoritative.json +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.0-homograph-api-schema-authoritative.json @@ -351,6 +351,69 @@ "studentSchoolAssociationReference" ], "type": "object" + }, + "Homograph_Contact_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_Contact_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_Contact_TrackedChangeKey": { + "properties": { + "contactFirstName": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "contactLastSurname": { + "maxLength": 75, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "contactFirstName", + "contactLastSurname" + ], + "type": "object" + }, + "Homograph_Contact_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_Contact_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_Contact_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -433,7 +496,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -476,7 +539,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -496,6 +559,124 @@ "x-Ed-Fi-domains": [ ] }, + "/homograph/contacts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographContactsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Contact_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "contacts" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/contacts/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographContactsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Contact_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "contacts" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/homograph/contacts/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -531,7 +712,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -563,15 +744,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -598,7 +770,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -655,7 +827,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -850,6 +1022,69 @@ "lastSurname" ], "type": "object" + }, + "Homograph_Name_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_Name_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_Name_TrackedChangeKey": { + "properties": { + "firstName": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "lastSurname": { + "maxLength": 75, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "firstName", + "lastSurname" + ], + "type": "object" + }, + "Homograph_Name_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_Name_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_Name_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -932,7 +1167,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -975,7 +1210,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -995,27 +1230,40 @@ "x-Ed-Fi-domains": [ ] }, - "/homograph/names/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_HomographNamesById", + "/homograph/names/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographNamesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Name_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -1029,48 +1277,144 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "names" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/names/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_HomographNamesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographNamesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Name_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "names" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/names/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_HomographNamesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "names" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_HomographNamesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" } + }, + { + "$ref": "#/components/parameters/If-None-Match" } ], "responses": { @@ -1097,7 +1441,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1154,7 +1498,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1309,6 +1653,62 @@ "schoolYear" ], "type": "object" + }, + "Homograph_SchoolYearType_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_SchoolYearType_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_SchoolYearType_TrackedChangeKey": { + "properties": { + "schoolYear": { + "maxLength": 20, + "type": "string" + } + }, + "required": [ + "schoolYear" + ], + "type": "object" + }, + "Homograph_SchoolYearType_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_SchoolYearType_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_SchoolYearType_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -1379,7 +1779,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1422,7 +1822,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1442,6 +1842,124 @@ "x-Ed-Fi-domains": [ ] }, + "/homograph/schoolYearTypes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographSchoolYearTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_SchoolYearType_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolYearTypes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/schoolYearTypes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographSchoolYearTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_SchoolYearType_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolYearTypes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/homograph/schoolYearTypes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -1477,7 +1995,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1509,15 +2027,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -1544,7 +2053,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1601,7 +2110,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1825,6 +2334,62 @@ "schoolName" ], "type": "object" + }, + "Homograph_School_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_School_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_School_TrackedChangeKey": { + "properties": { + "schoolName": { + "maxLength": 100, + "type": "string" + } + }, + "required": [ + "schoolName" + ], + "type": "object" + }, + "Homograph_School_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_School_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_School_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -1905,7 +2470,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1948,7 +2513,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1968,6 +2533,124 @@ "x-Ed-Fi-domains": [ ] }, + "/homograph/schools/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographSchoolsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_School_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schools" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/schools/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographSchoolsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_School_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schools" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/homograph/schools/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -2003,7 +2686,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2035,15 +2718,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -2070,7 +2744,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2127,7 +2801,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2465,6 +3139,69 @@ "studentSchoolAssociationReference" ], "type": "object" + }, + "Homograph_Staff_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_Staff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_Staff_TrackedChangeKey": { + "properties": { + "staffFirstName": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "staffLastSurname": { + "maxLength": 75, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "staffFirstName", + "staffLastSurname" + ], + "type": "object" + }, + "Homograph_Staff_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_Staff_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_Staff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -2547,7 +3284,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2590,7 +3327,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2610,6 +3347,124 @@ "x-Ed-Fi-domains": [ ] }, + "/homograph/staffs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStaffsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Staff_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffs" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/staffs/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStaffsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Staff_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffs" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/homograph/staffs/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -2645,7 +3500,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2677,15 +3532,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -2712,7 +3558,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2769,7 +3615,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3012,6 +3858,74 @@ "studentLastSurname" ], "type": "object" + }, + "Homograph_StudentSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_StudentSchoolAssociation_TrackedChangeKey": { + "properties": { + "schoolName": { + "maxLength": 100, + "type": "string" + }, + "studentFirstName": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "studentLastSurname": { + "maxLength": 75, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "schoolName", + "studentFirstName", + "studentLastSurname" + ], + "type": "object" + }, + "Homograph_StudentSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3045,36 +3959,147 @@ } }, { - "description": "The name of the school.", - "in": "query", - "name": "schoolName", - "schema": { - "maxLength": 100, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "description": "The name of the school.", + "in": "query", + "name": "schoolName", + "schema": { + "maxLength": 100, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "in": "query", + "name": "studentFirstName", + "schema": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "The name borne in common by members of a family.", + "in": "query", + "name": "studentLastSurname", + "schema": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "studentSchoolAssociations" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_HomographStudentSchoolAssociation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation" + } + } + }, + "description": "The JSON representation of the StudentSchoolAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSchoolAssociation" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "studentSchoolAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/studentSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStudentSchoolAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", - "in": "query", - "name": "studentFirstName", - "schema": { - "maxLength": 75, - "minLength": 1, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "$ref": "#/components/parameters/limit" }, { - "description": "The name borne in common by members of a family.", - "in": "query", - "name": "studentLastSurname", - "schema": { - "maxLength": 75, - "minLength": 1, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -3083,16 +4108,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation" + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3104,38 +4126,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSchoolAssociations" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_HomographStudentSchoolAssociation", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/studentSchoolAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStudentSchoolAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the StudentSchoolAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSchoolAssociation" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3146,20 +4184,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSchoolAssociations" ] @@ -3202,7 +4234,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3234,15 +4266,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -3269,7 +4292,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3326,7 +4349,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3604,6 +4627,69 @@ "studentLastSurname" ], "type": "object" + }, + "Homograph_Student_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_Student_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_Student_TrackedChangeKey": { + "properties": { + "studentFirstName": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "studentLastSurname": { + "maxLength": 75, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "studentFirstName", + "studentLastSurname" + ], + "type": "object" + }, + "Homograph_Student_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_Student_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_Student_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3696,7 +4782,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3739,7 +4825,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3759,6 +4845,124 @@ "x-Ed-Fi-domains": [ ] }, + "/homograph/students/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStudentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Student_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "students" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/students/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStudentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Student_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "students" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/homograph/students/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -3794,7 +4998,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3826,15 +5030,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -3861,7 +5056,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3918,7 +5113,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" diff --git a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.0-sample-api-schema-authoritative.json b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.0-sample-api-schema-authoritative.json index 2d6ad3b54..51fc1b836 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.0-sample-api-schema-authoritative.json +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.0-sample-api-schema-authoritative.json @@ -211,6 +211,67 @@ "shortDescription" ], "type": "object" + }, + "Sample_ArtMediumDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_ArtMediumDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_ArtMediumDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Sample_ArtMediumDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_ArtMediumDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_ArtMediumDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -327,7 +388,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -370,7 +431,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -390,6 +451,124 @@ "x-Ed-Fi-domains": [ ] }, + "/sample/artMediumDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleArtMediaDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_ArtMediumDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "artMediumDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/artMediumDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleArtMediaKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_ArtMediumDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "artMediumDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/sample/artMediumDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -425,7 +604,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -457,15 +636,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -492,7 +662,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -549,7 +719,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1436,6 +1606,67 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "Sample_BusRoute_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_BusRoute_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_BusRoute_TrackedChangeKey": { + "properties": { + "busId": { + "maxLength": 120, + "type": "string" + }, + "busRouteNumber": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "busId", + "busRouteNumber" + ], + "type": "object" + }, + "Sample_BusRoute_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_BusRoute_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_BusRoute_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -1645,7 +1876,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1688,7 +1919,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1708,27 +1939,40 @@ "x-Ed-Fi-domains": [ ] }, - "/sample/busRoutes/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_SampleBusRoutesById", + "/sample/busRoutes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleBusRoutesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_BusRoute_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -1742,48 +1986,144 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "busRoutes" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/busRoutes/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_SampleBusRoutesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleBusRoutesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_BusRoute_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "busRoutes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/busRoutes/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_SampleBusRoutesById", + "parameters": [ { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, "schema": { - "default": false, - "type": "boolean" + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "busRoutes" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_SampleBusRoutesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" } + }, + { + "$ref": "#/components/parameters/If-None-Match" } ], "responses": { @@ -1810,7 +2150,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1867,7 +2207,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2106,6 +2446,62 @@ "busId" ], "type": "object" + }, + "Sample_Bus_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_Bus_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_Bus_TrackedChangeKey": { + "properties": { + "busId": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "busId" + ], + "type": "object" + }, + "Sample_Bus_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_Bus_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_Bus_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -2176,7 +2572,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2219,7 +2615,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2239,27 +2635,40 @@ "x-Ed-Fi-domains": [ ] }, - "/sample/buses/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_SampleBusesById", + "/sample/buses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleBusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_Bus_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2273,48 +2682,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "buses" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/buses/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_SampleBusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleBusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -2322,14 +2720,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Sample_Bus" + "items": { + "$ref": "#/components/schemas/Sample_Bus_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2341,20 +2739,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "buses" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "put_SampleBus", + "x-Ed-Fi-domains": [ + ] + }, + "/sample/buses/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_SampleBusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -2369,18 +2771,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Sample_Bus" - } - } - }, - "description": "The JSON representation of the Bus resource to be created or updated.", - "required": true, - "x-bodyName": "Bus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -2398,7 +2788,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2410,7 +2800,122 @@ "$ref": "#/components/responses/Error" } }, - "summary": "Updates a resource based on the resource identifier.", + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "buses" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_SampleBusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Sample_Bus" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "buses" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "put_SampleBus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Sample_Bus" + } + } + }, + "description": "The JSON representation of the Bus resource to be created or updated.", + "required": true, + "x-bodyName": "Bus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Updates a resource based on the resource identifier.", "tags": [ "buses" ] @@ -3662,6 +4167,67 @@ "shortDescription" ], "type": "object" + }, + "Sample_FavoriteBookCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_FavoriteBookCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_FavoriteBookCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Sample_FavoriteBookCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_FavoriteBookCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_FavoriteBookCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3778,7 +4344,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3821,7 +4387,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3841,6 +4407,124 @@ "x-Ed-Fi-domains": [ ] }, + "/sample/favoriteBookCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleFavoriteBookCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_FavoriteBookCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "favoriteBookCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/favoriteBookCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleFavoriteBookCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_FavoriteBookCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "favoriteBookCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/sample/favoriteBookCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -3876,7 +4560,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3908,15 +4592,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -3943,7 +4618,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4000,7 +4675,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4227,6 +4902,67 @@ "shortDescription" ], "type": "object" + }, + "Sample_MembershipTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_MembershipTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Sample_MembershipTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -4307,13 +5043,124 @@ "x-Ed-Fi-isIdentity": true }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "membershipTypeDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_SampleMembershipType", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor" + } + } + }, + "description": "The JSON representation of the MembershipType resource to be created or updated.", + "required": true, + "x-bodyName": "MembershipType" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "membershipTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/membershipTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleMembershipTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -4322,16 +5169,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor" + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4343,38 +5187,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "membershipTypeDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_SampleMembershipType", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/sample/membershipTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleMembershipTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the MembershipType resource to be created or updated.", - "required": true, - "x-bodyName": "MembershipType" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4385,20 +5245,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "membershipTypeDescriptors" ] @@ -4441,7 +5295,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4473,15 +5327,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -4508,7 +5353,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4565,7 +5410,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6219,6 +7064,87 @@ "style" ], "type": "object" + }, + "Sample_StudentArtProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_StudentArtProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "Sample_StudentArtProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -6418,21 +7344,132 @@ } }, { - "description": "The reason the student left the program within a school or district.", - "in": "query", - "name": "reasonExitedDescriptor", - "schema": { - "maxLength": 306, - "type": "string" - } + "description": "The reason the student left the program within a school or district.", + "in": "query", + "name": "reasonExitedDescriptor", + "schema": { + "maxLength": 306, + "type": "string" + } + }, + { + "description": "Indicates whether the student received services during the summer session or between sessions.", + "in": "query", + "name": "servedOutsideOfRegularSession", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "studentArtProgramAssociations" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_SampleStudentArtProgramAssociation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentArtProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentArtProgramAssociation" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "studentArtProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/studentArtProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleStudentArtProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" }, { - "description": "Indicates whether the student received services during the summer session or between sessions.", - "in": "query", - "name": "servedOutsideOfRegularSession", - "schema": { - "type": "boolean" - } + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -6441,16 +7478,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation" + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6462,38 +7496,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentArtProgramAssociations" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_SampleStudentArtProgramAssociation", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/sample/studentArtProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleStudentArtProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the StudentArtProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentArtProgramAssociation" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6504,20 +7554,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentArtProgramAssociations" ] @@ -6560,7 +7604,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6592,15 +7636,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -6627,7 +7662,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6684,7 +7719,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9196,6 +10231,77 @@ ], "type": "object" }, + "Sample_StudentGraduationPlanAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_StudentGraduationPlanAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_StudentGraduationPlanAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "graduationPlanTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "graduationSchoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "graduationPlanTypeDescriptor", + "graduationSchoolYear", + "studentUniqueId" + ], + "type": "object" + }, + "Sample_StudentGraduationPlanAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_StudentGraduationPlanAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_StudentGraduationPlanAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "Sample_StudentGraduationPlanAssociation_YearsAttended": { "properties": { "yearsAttended": { @@ -9388,7 +10494,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9431,7 +10537,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9451,6 +10557,124 @@ "x-Ed-Fi-domains": [ ] }, + "/sample/studentGraduationPlanAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleStudentGraduationPlanAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_StudentGraduationPlanAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentGraduationPlanAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/studentGraduationPlanAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleStudentGraduationPlanAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_StudentGraduationPlanAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentGraduationPlanAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/sample/studentGraduationPlanAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -9486,7 +10710,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9518,15 +10742,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -9553,7 +10768,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9610,7 +10825,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" diff --git a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.1-api-schema-authoritative.json b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.1-api-schema-authoritative.json index 95d42fc08..7ae77c551 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.1-api-schema-authoritative.json +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.1-api-schema-authoritative.json @@ -1100,6 +1100,66 @@ ], "isExtensionProject": false, "openApiBaseDocuments": { + "changeQueries": { + "components": { + "parameters": { + }, + "responses": { + }, + "schemas": { + } + }, + "info": { + "contact": { + "url": "https://www.ed-fi.org/what-is-ed-fi/contact/" + }, + "description": "The Ed-Fi DMS API enables applications to read and write education data stored in an Ed-Fi DMS through a secure REST interface. \n***\n > *Note: Consumers of DMS information should sanitize all data for display and storage. DMS provides reasonable safeguards against cross-site scripting attacks and other malicious content, but the platform does not and cannot guarantee that the data it contains is free of all potentially harmful content.* \n***\n", + "title": "Ed-Fi Data Management Service API", + "version": "1" + }, + "openapi": "3.0.0", + "paths": { + "/availableChangeVersions": { + "get": { + "operationId": "getAvailableChangeVersions", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "newestChangeVersion": { + "format": "int64", + "type": "integer" + }, + "oldestChangeVersion": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "oldestChangeVersion", + "newestChangeVersion" + ], + "type": "object" + } + } + }, + "description": "The available change version range was successfully retrieved." + } + }, + "summary": "Retrieves the available change version range." + } + } + }, + "servers": [ + { + "url": "" + } + ], + "tags": [ + ] + }, "descriptors": { "components": { "parameters": { @@ -1125,6 +1185,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1134,6 +1195,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1248,9 +1310,6 @@ "NotFound": { "description": "The resource could not be found." }, - "NotFoundUseSnapshot": { - "description": "The resource could not be found. If Use-Snapshot header is set to true, this response can indicate the snapshot may have been removed." - }, "NotModified": { "description": "The resource's current server-side ETag value matched the If-None-Match header value supplied with the request indicating the resource has not been modified." }, @@ -1311,6 +1370,7 @@ "name": "maxChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1320,6 +1380,7 @@ "name": "minChangeVersion", "schema": { "format": "int64", + "minimum": 0, "type": "integer" } }, @@ -1434,9 +1495,6 @@ "NotFound": { "description": "The resource could not be found." }, - "NotFoundUseSnapshot": { - "description": "The resource could not be found. If Use-Snapshot header is set to true, this response can indicate the snapshot may have been removed." - }, "NotModified": { "description": "The resource's current server-side ETag value matched the If-None-Match header value supplied with the request indicating the resource has not been modified." }, @@ -2105,6 +2163,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AbsenceEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -2221,7 +2340,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2264,7 +2383,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2285,6 +2404,126 @@ "Staff" ] }, + "/ed-fi/absenceEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAbsenceEventCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "absenceEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/absenceEventCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAbsenceEventCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AbsenceEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "absenceEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/absenceEventCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -2320,7 +2559,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2352,15 +2591,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -2387,7 +2617,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2444,7 +2674,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2675,6 +2905,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AcademicHonorCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -2791,7 +3082,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2834,7 +3125,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2859,27 +3150,40 @@ "StudentTranscript" ] }, - "/ed-fi/academicHonorCategoryDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAcademicHonorCategoriesById", + "/ed-fi/academicHonorCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicHonorCategoriesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2893,48 +3197,42 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "academicHonorCategoryDescriptors" ] }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/academicHonorCategoryDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAcademicHonorCategoriesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicHonorCategoriesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -2942,14 +3240,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2961,20 +3259,29 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "academicHonorCategoryDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAcademicHonorCategory", + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/academicHonorCategoryDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAcademicHonorCategoriesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -2989,18 +3296,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" - } - } - }, - "description": "The JSON representation of the AcademicHonorCategory resource to be created or updated.", - "required": true, - "x-bodyName": "AcademicHonorCategory" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -3018,7 +3313,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "academicHonorCategoryDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAcademicHonorCategoriesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "academicHonorCategoryDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAcademicHonorCategory", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicHonorCategoryDescriptor" + } + } + }, + "description": "The JSON representation of the AcademicHonorCategory resource to be created or updated.", + "required": true, + "x-bodyName": "AcademicHonorCategory" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3274,6 +3684,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AcademicSubjectDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AcademicSubjectDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AcademicSubjectDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3390,7 +3861,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3433,7 +3904,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3479,82 +3950,25 @@ "StudentTranscript" ] }, - "/ed-fi/academicSubjectDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "deleteAcademicSubjectsById", + "/ed-fi/academicSubjectDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicSubjectsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Updated" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "404": { - "$ref": "#/components/responses/NotFound" - }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "$ref": "#/components/parameters/MaxChangeVersion" }, - "500": { - "$ref": "#/components/responses/Error" - } - }, - "summary": "Deletes an existing resource using the resource identifier.", - "tags": [ - "academicSubjectDescriptors" - ] - }, - "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "getAcademicSubjectsById", - "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/limit" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/offset" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -3562,68 +3976,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" + "items": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeDelete" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" - }, - "400": { - "$ref": "#/components/responses/BadRequest" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" - }, - "500": { - "$ref": "#/components/responses/Error" - } - }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", - "tags": [ - "academicSubjectDescriptors" - ] - }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "putAcademicSubject", - "parameters": [ - { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/If-Match" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" - } - } - }, - "description": "The JSON representation of the AcademicSubject resource to be created or updated.", - "required": true, - "x-bodyName": "AcademicSubject" - }, - "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3637,20 +3997,292 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Updates a resource based on the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "academicSubjectDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Credential", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "PerformanceEvaluation", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "Standards", + "StudentTranscript" + ] + }, + "/ed-fi/academicSubjectDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicSubjectsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "academicSubjectDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Credential", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "PerformanceEvaluation", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "Standards", + "StudentTranscript" + ] + }, + "/ed-fi/academicSubjectDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "deleteAcademicSubjectsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "academicSubjectDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "getAcademicSubjectsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "academicSubjectDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "putAcademicSubject", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EdFi_AcademicSubjectDescriptor" + } + } + }, + "description": "The JSON representation of the AcademicSubject resource to be created or updated.", + "required": true, + "x-bodyName": "AcademicSubject" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Updates a resource based on the resource identifier.", "tags": [ "academicSubjectDescriptors" ] @@ -3952,6 +4584,68 @@ "weekIdentifier" ], "type": "object" + }, + "EdFi_AcademicWeek_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AcademicWeek_TrackedChangeKey": { + "properties": { + "schoolId": { + "format": "int64", + "type": "integer" + }, + "weekIdentifier": { + "maxLength": 80, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "schoolId", + "weekIdentifier" + ], + "type": "object" + }, + "EdFi_AcademicWeek_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -4060,7 +4754,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4103,7 +4797,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4124,6 +4818,126 @@ "SchoolCalendar" ] }, + "/ed-fi/academicWeeks/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicWeeksDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "academicWeeks" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/academicWeeks/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAcademicWeeksKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AcademicWeek_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "academicWeeks" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, "/ed-fi/academicWeeks/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -4159,7 +4973,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4191,15 +5005,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -4226,7 +5031,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4283,7 +5088,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4510,6 +5315,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AccommodationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccommodationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AccommodationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -4626,7 +5492,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4669,7 +5535,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4693,6 +5559,132 @@ "StudentAssessment" ] }, + "/ed-fi/accommodationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccommodationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "accommodationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentRegistration", + "SpecialEducationDataModel", + "StudentAssessment" + ] + }, + "/ed-fi/accommodationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccommodationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccommodationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "accommodationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentRegistration", + "SpecialEducationDataModel", + "StudentAssessment" + ] + }, "/ed-fi/accommodationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -4728,7 +5720,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4760,15 +5752,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -4795,7 +5778,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4852,7 +5835,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5082,6 +6065,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AccountTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccountTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AccountTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -5198,7 +6242,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5241,7 +6285,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5262,6 +6306,126 @@ "Finance" ] }, + "/ed-fi/accountTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccountTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "accountTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/accountTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccountTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccountTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "accountTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/accountTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -5297,7 +6461,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5329,15 +6493,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -5364,7 +6519,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5421,7 +6576,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5768,6 +6923,72 @@ "schoolYear" ], "type": "object" + }, + "EdFi_AccountabilityRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccountabilityRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "ratingTitle": { + "maxLength": 60, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "educationOrganizationId", + "ratingTitle", + "schoolYear" + ], + "type": "object" + }, + "EdFi_AccountabilityRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -5894,7 +7115,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5937,7 +7158,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5959,6 +7180,128 @@ "Enrollment" ] }, + "/ed-fi/accountabilityRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccountabilityRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "accountabilityRatings" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment" + ] + }, + "/ed-fi/accountabilityRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccountabilityRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccountabilityRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "accountabilityRatings" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment" + ] + }, "/ed-fi/accountabilityRatings/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -5994,7 +7337,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6026,15 +7369,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -6061,7 +7395,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6118,7 +7452,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6369,6 +7703,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AccreditationStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AccreditationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AccreditationStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AccreditationStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AccreditationStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AccreditationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -6485,7 +7880,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6528,7 +7923,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6563,6 +7958,154 @@ "SectionsAndPrograms" ] }, + "/ed-fi/accreditationStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAccreditationStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccreditationStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "accreditationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/accreditationStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAccreditationStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AccreditationStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "accreditationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/accreditationStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -6598,7 +8141,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6630,15 +8173,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -6665,7 +8199,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6722,7 +8256,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6976,6 +8510,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AchievementCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AchievementCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AchievementCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -7092,7 +8687,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7135,7 +8730,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7169,6 +8764,152 @@ "StudentTranscript" ] }, + "/ed-fi/achievementCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAchievementCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "achievementCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Graduation", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/achievementCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAchievementCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AchievementCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "achievementCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Graduation", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/achievementCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -7204,7 +8945,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7236,15 +8977,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -7271,7 +9003,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7328,7 +9060,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7571,6 +9303,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AdditionalCreditTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -7687,7 +9480,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7730,7 +9523,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7754,6 +9547,132 @@ "StudentTranscript" ] }, + "/ed-fi/additionalCreditTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAdditionalCreditTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "additionalCreditTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/additionalCreditTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAdditionalCreditTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdditionalCreditTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "additionalCreditTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/additionalCreditTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -7789,7 +9708,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7821,15 +9740,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -7856,7 +9766,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7913,7 +9823,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8164,6 +10074,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AddressCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AddressCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AddressCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AddressCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AddressCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AddressCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -8280,7 +10251,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8323,7 +10294,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8365,6 +10336,168 @@ "StudentTranscript" ] }, + "/ed-fi/addressCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAddressCharacteristicsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AddressCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "addressCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/addressCharacteristicDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAddressCharacteristicsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AddressCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "addressCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/addressCharacteristicDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -8400,7 +10533,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8432,15 +10565,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -8467,7 +10591,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8524,7 +10648,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8793,6 +10917,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AddressTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AddressTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AddressTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -8909,7 +11094,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8952,7 +11137,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8994,6 +11179,168 @@ "StudentTranscript" ] }, + "/ed-fi/addressTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAddressTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "addressTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/addressTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAddressTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AddressTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "addressTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/addressTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -9029,7 +11376,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9061,15 +11408,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -9096,7 +11434,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9153,7 +11491,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9402,6 +11740,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AdministrationEnvironmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -9518,7 +11917,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9561,7 +11960,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9583,6 +11982,128 @@ "StudentAssessment" ] }, + "/ed-fi/administrationEnvironmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrationEnvironmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "administrationEnvironmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/administrationEnvironmentDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrationEnvironmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdministrationEnvironmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "administrationEnvironmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, "/ed-fi/administrationEnvironmentDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -9618,7 +12139,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9650,15 +12171,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -9685,7 +12197,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9742,7 +12254,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9983,6 +12495,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AdministrativeFundingControlDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -10099,7 +12672,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10142,7 +12715,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10176,6 +12749,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/administrativeFundingControlDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrativeFundingControlsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "administrativeFundingControlDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/administrativeFundingControlDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAdministrativeFundingControlsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AdministrativeFundingControlDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "administrativeFundingControlDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/administrativeFundingControlDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -10211,7 +12930,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10243,15 +12962,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -10278,7 +12988,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10335,7 +13045,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10575,6 +13285,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AidTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AidTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AidTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AidTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AidTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AidTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -10691,7 +13462,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10734,7 +13505,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10755,6 +13526,126 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/aidTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAidTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AidTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "aidTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/aidTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAidTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AidTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "aidTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/aidTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -10790,7 +13681,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10822,15 +13713,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -10857,7 +13739,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -10914,7 +13796,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -11144,6 +14026,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AncestryEthnicOriginDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -11260,7 +14203,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -11303,7 +14246,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -11327,6 +14270,132 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/ancestryEthnicOriginDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAncestryEthnicOriginsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "ancestryEthnicOriginDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "Enrollment", + "Staff", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/ancestryEthnicOriginDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAncestryEthnicOriginsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AncestryEthnicOriginDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "ancestryEthnicOriginDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "Enrollment", + "Staff", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/ancestryEthnicOriginDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -11362,7 +14431,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -11394,15 +14463,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -11429,7 +14489,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -11486,7 +14546,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14144,6 +17204,63 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "EdFi_ApplicantProfile_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ApplicantProfile_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ApplicantProfile_TrackedChangeKey": { + "properties": { + "applicantProfileIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "applicantProfileIdentifier" + ], + "type": "object" + }, + "EdFi_ApplicantProfile_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicantProfile_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicantProfile_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -14383,7 +17500,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14426,7 +17543,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14447,6 +17564,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/applicantProfiles/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getApplicantProfilesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicantProfile_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "applicantProfiles" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/applicantProfiles/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getApplicantProfilesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicantProfile_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "applicantProfiles" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/applicantProfiles/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -14482,7 +17719,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14514,15 +17751,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -14549,7 +17777,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14606,7 +17834,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14924,6 +18152,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ApplicationEventResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEventResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ApplicationEventResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ApplicationEventResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEventResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEventResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -15040,7 +18329,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15083,7 +18372,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15104,6 +18393,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/applicationEventResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationEventResultsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationEventResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "applicationEventResultDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/applicationEventResultDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationEventResultsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationEventResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "applicationEventResultDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/applicationEventResultDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -15139,7 +18548,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15171,15 +18580,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -15206,7 +18606,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15263,7 +18663,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15490,6 +18890,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ApplicationEventTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ApplicationEventTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ApplicationEventTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEventTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -15606,7 +19067,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15649,7 +19110,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15670,6 +19131,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/applicationEventTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationEventTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationEventTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "applicationEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/applicationEventTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationEventTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationEventTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "applicationEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/applicationEventTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -15705,7 +19286,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15737,15 +19318,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -15772,7 +19344,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15829,7 +19401,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16280,6 +19852,89 @@ "sequenceNumber" ], "type": "object" + }, + "EdFi_ApplicationEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ApplicationEvent_TrackedChangeKey": { + "properties": { + "applicantProfileIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "applicationEventTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "applicationIdentifier": { + "maxLength": 20, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "sequenceNumber": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "applicantProfileIdentifier", + "applicationEventTypeDescriptor", + "applicationIdentifier", + "educationOrganizationId", + "eventDate", + "sequenceNumber" + ], + "type": "object" + }, + "EdFi_ApplicationEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -16447,7 +20102,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16490,7 +20145,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16511,6 +20166,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/applicationEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "applicationEvents" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/applicationEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "applicationEvents" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/applicationEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -16546,7 +20321,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16578,15 +20353,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -16613,7 +20379,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16670,7 +20436,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -16930,6 +20696,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ApplicationSourceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationSourceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ApplicationSourceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ApplicationSourceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationSourceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationSourceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -17046,7 +20873,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17089,7 +20916,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17110,6 +20937,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/applicationSourceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationSourcesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationSourceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "applicationSourceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/applicationSourceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationSourcesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationSourceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "applicationSourceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/applicationSourceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -17145,7 +21092,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17177,15 +21124,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -17212,7 +21150,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17269,7 +21207,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17496,6 +21434,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ApplicationStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ApplicationStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ApplicationStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ApplicationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -17612,7 +21611,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17655,7 +21654,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17676,6 +21675,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/applicationStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "applicationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/applicationStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ApplicationStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "applicationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/applicationStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -17711,7 +21830,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17743,15 +21862,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -17778,7 +21888,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17835,7 +21945,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18656,6 +22766,74 @@ "termDescriptor" ], "type": "object" + }, + "EdFi_Application_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Application_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Application_TrackedChangeKey": { + "properties": { + "applicantProfileIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "applicationIdentifier": { + "maxLength": 20, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "applicantProfileIdentifier", + "applicationIdentifier", + "educationOrganizationId" + ], + "type": "object" + }, + "EdFi_Application_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Application_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Application_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -18865,7 +23043,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18908,7 +23086,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18929,6 +23107,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/applications/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Application_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "applications" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/applications/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getApplicationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Application_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "applications" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/applications/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -18964,7 +23262,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18996,15 +23294,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -19031,7 +23320,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19088,7 +23377,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19601,6 +23890,83 @@ "participatingEducationOrganizationId" ], "type": "object" + }, + "EdFi_AssessmentAdministrationParticipation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentAdministrationParticipation_TrackedChangeKey": { + "properties": { + "administrationIdentifier": { + "maxLength": 255, + "type": "string" + }, + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "assigningEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "participatingEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "administrationIdentifier", + "assessmentIdentifier", + "assigningEducationOrganizationId", + "namespace", + "participatingEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_AssessmentAdministrationParticipation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -19712,7 +24078,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19755,7 +24121,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19776,6 +24142,126 @@ "AssessmentRegistration" ] }, + "/ed-fi/assessmentAdministrationParticipations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentAdministrationParticipationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentAdministrationParticipations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/assessmentAdministrationParticipations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentAdministrationParticipationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministrationParticipation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentAdministrationParticipations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, "/ed-fi/assessmentAdministrationParticipations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -19811,7 +24297,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19843,15 +24329,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -19878,7 +24355,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19935,7 +24412,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20392,6 +24869,78 @@ "assigningEducationOrganizationId" ], "type": "object" + }, + "EdFi_AssessmentAdministration_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentAdministration_TrackedChangeKey": { + "properties": { + "administrationIdentifier": { + "maxLength": 255, + "type": "string" + }, + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "assigningEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "administrationIdentifier", + "assessmentIdentifier", + "assigningEducationOrganizationId", + "namespace" + ], + "type": "object" + }, + "EdFi_AssessmentAdministration_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -20493,7 +25042,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20536,7 +25085,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20557,6 +25106,126 @@ "AssessmentRegistration" ] }, + "/ed-fi/assessmentAdministrations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentAdministrationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentAdministrations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/assessmentAdministrations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentAdministrationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentAdministration_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentAdministrations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, "/ed-fi/assessmentAdministrations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -20592,7 +25261,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20624,15 +25293,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -20659,7 +25319,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20716,7 +25376,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21055,6 +25715,73 @@ "assessmentBatteryPartName" ], "type": "object" + }, + "EdFi_AssessmentBatteryPart_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentBatteryPart_TrackedChangeKey": { + "properties": { + "assessmentBatteryPartName": { + "maxLength": 65, + "type": "string" + }, + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentBatteryPartName", + "assessmentIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_AssessmentBatteryPart_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -21146,7 +25873,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21189,7 +25916,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21210,6 +25937,126 @@ "AssessmentRegistration" ] }, + "/ed-fi/assessmentBatteryParts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentBatteryPartsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentBatteryParts" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/assessmentBatteryParts/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentBatteryPartsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentBatteryPart_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentBatteryParts" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, "/ed-fi/assessmentBatteryParts/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -21245,7 +26092,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21277,15 +26124,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -21312,7 +26150,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21369,7 +26207,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21580,6 +26418,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -21696,7 +26595,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21739,7 +26638,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21761,6 +26660,128 @@ "AssessmentMetadata" ] }, + "/ed-fi/assessmentCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessmentCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, "/ed-fi/assessmentCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -21796,7 +26817,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21828,15 +26849,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -21863,7 +26875,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21920,7 +26932,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22149,6 +27161,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -22265,7 +27338,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22308,7 +27381,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22330,6 +27403,128 @@ "AssessmentMetadata" ] }, + "/ed-fi/assessmentIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentIdentificationSystemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessmentIdentificationSystemDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentIdentificationSystemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, "/ed-fi/assessmentIdentificationSystemDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -22365,7 +27560,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22397,15 +27592,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -22432,7 +27618,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22489,7 +27675,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22718,6 +27904,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentItemCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -22834,7 +28081,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22877,7 +28124,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22899,6 +28146,128 @@ "AssessmentMetadata" ] }, + "/ed-fi/assessmentItemCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentItemCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessmentItemCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentItemCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, "/ed-fi/assessmentItemCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -22934,7 +28303,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22966,15 +28335,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -23001,7 +28361,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23058,7 +28418,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23287,6 +28647,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentItemResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentItemResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentItemResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -23403,7 +28824,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23446,7 +28867,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23468,6 +28889,128 @@ "StudentAssessment" ] }, + "/ed-fi/assessmentItemResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemResultsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentItemResultDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/assessmentItemResultDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemResultsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItemResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentItemResultDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, "/ed-fi/assessmentItemResultDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -23503,7 +29046,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23535,15 +29078,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -23570,7 +29104,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23627,7 +29161,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24144,6 +29678,73 @@ "identificationCode" ], "type": "object" + }, + "EdFi_AssessmentItem_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentItem_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "identificationCode": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "identificationCode", + "namespace" + ], + "type": "object" + }, + "EdFi_AssessmentItem_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -24290,7 +29891,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24333,7 +29934,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24355,6 +29956,128 @@ "AssessmentMetadata" ] }, + "/ed-fi/assessmentItems/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentItems" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessmentItems/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentItemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentItem_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentItems" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, "/ed-fi/assessmentItems/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -24390,7 +30113,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24422,15 +30145,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -24457,7 +30171,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24514,7 +30228,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24762,6 +30476,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -24878,7 +30653,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24921,7 +30696,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24944,6 +30719,130 @@ "StudentAssessment" ] }, + "/ed-fi/assessmentPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentPeriodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata", + "StudentAssessment" + ] + }, + "/ed-fi/assessmentPeriodDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentPeriodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata", + "StudentAssessment" + ] + }, "/ed-fi/assessmentPeriodDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -24979,7 +30878,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25011,15 +30910,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -25046,7 +30936,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25103,7 +30993,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25337,6 +31227,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssessmentReportingMethodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -25453,7 +31404,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25496,7 +31447,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25522,6 +31473,136 @@ "StudentAssessment" ] }, + "/ed-fi/assessmentReportingMethodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentReportingMethodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentReportingMethodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "Enrollment", + "Graduation", + "RecruitingAndStaffing", + "AssessmentMetadata", + "StudentAssessment" + ] + }, + "/ed-fi/assessmentReportingMethodDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentReportingMethodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentReportingMethodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentReportingMethodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "Enrollment", + "Graduation", + "RecruitingAndStaffing", + "AssessmentMetadata", + "StudentAssessment" + ] + }, "/ed-fi/assessmentReportingMethodDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -25557,7 +31638,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25589,15 +31670,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -25624,7 +31696,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25681,7 +31753,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26125,6 +32197,73 @@ "scoreRangeId" ], "type": "object" + }, + "EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "scoreRangeId": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "namespace", + "scoreRangeId" + ], + "type": "object" + }, + "EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -26253,7 +32392,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -26296,7 +32435,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26317,6 +32456,126 @@ "Assessment" ] }, + "/ed-fi/assessmentScoreRangeLearningStandards/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentScoreRangeLearningStandardsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessmentScoreRangeLearningStandards" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, + "/ed-fi/assessmentScoreRangeLearningStandards/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentScoreRangeLearningStandardsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssessmentScoreRangeLearningStandard_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessmentScoreRangeLearningStandards" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, "/ed-fi/assessmentScoreRangeLearningStandards/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -26352,7 +32611,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26384,15 +32643,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -26419,7 +32669,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -26476,7 +32726,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27983,6 +34233,68 @@ "sectionReference" ], "type": "object" + }, + "EdFi_Assessment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Assessment_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_Assessment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -28163,7 +34475,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28206,7 +34518,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28228,6 +34540,128 @@ "AssessmentMetadata" ] }, + "/ed-fi/assessments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assessments" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/assessments/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssessmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Assessment_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assessments" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, "/ed-fi/assessments/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -28263,7 +34697,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28295,15 +34729,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -28330,7 +34755,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28387,7 +34812,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28667,6 +35092,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AssignmentLateStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AssignmentLateStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -28783,7 +35269,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -28826,7 +35312,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28848,6 +35334,128 @@ "Gradebook" ] }, + "/ed-fi/assignmentLateStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAssignmentLateStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "assignmentLateStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/assignmentLateStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAssignmentLateStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AssignmentLateStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "assignmentLateStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, "/ed-fi/assignmentLateStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -28883,7 +35491,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -28915,15 +35523,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -28950,7 +35549,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29007,7 +35606,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29243,6 +35842,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AttemptStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AttemptStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AttemptStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -29359,7 +36019,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29402,7 +36062,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29431,6 +36091,142 @@ "SectionsAndPrograms" ] }, + "/ed-fi/attemptStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAttemptStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "attemptStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/attemptStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAttemptStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AttemptStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "attemptStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/attemptStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -29466,7 +36262,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29498,15 +36294,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -29533,7 +36320,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29590,7 +36377,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -29829,6 +36616,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_AttendanceEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -29945,7 +36793,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -29988,7 +36836,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -30013,6 +36861,134 @@ "StudentAttendance" ] }, + "/ed-fi/attendanceEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getAttendanceEventCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "attendanceEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Intervention", + "RecruitingAndStaffing", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/attendanceEventCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getAttendanceEventCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_AttendanceEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "attendanceEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Intervention", + "RecruitingAndStaffing", + "SpecialEducation", + "StudentAttendance" + ] + }, "/ed-fi/attendanceEventCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -30048,7 +37024,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -30080,15 +37056,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -30115,7 +37082,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30172,7 +37139,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -30405,6 +37372,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BackgroundCheckStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BackgroundCheckStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BackgroundCheckStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -30521,7 +37549,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30564,7 +37592,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -30587,6 +37615,130 @@ "Staff" ] }, + "/ed-fi/backgroundCheckStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBackgroundCheckStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "backgroundCheckStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "RecruitingAndStaffing", + "Staff" + ] + }, + "/ed-fi/backgroundCheckStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBackgroundCheckStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "backgroundCheckStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "RecruitingAndStaffing", + "Staff" + ] + }, "/ed-fi/backgroundCheckStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -30622,7 +37774,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -30654,15 +37806,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -30689,7 +37832,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -30746,7 +37889,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -30977,6 +38120,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BackgroundCheckTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BackgroundCheckTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BackgroundCheckTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -31093,7 +38297,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31136,7 +38340,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31159,6 +38363,130 @@ "Staff" ] }, + "/ed-fi/backgroundCheckTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBackgroundCheckTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "backgroundCheckTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "RecruitingAndStaffing", + "Staff" + ] + }, + "/ed-fi/backgroundCheckTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBackgroundCheckTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BackgroundCheckTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "backgroundCheckTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "RecruitingAndStaffing", + "Staff" + ] + }, "/ed-fi/backgroundCheckTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -31194,7 +38522,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31226,15 +38554,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -31261,7 +38580,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31318,7 +38637,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31608,6 +38927,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_BalanceSheetDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BalanceSheetDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_BalanceSheetDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -31697,7 +39077,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31740,7 +39120,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31761,6 +39141,126 @@ "Finance" ] }, + "/ed-fi/balanceSheetDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBalanceSheetDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "balanceSheetDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/balanceSheetDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBalanceSheetDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BalanceSheetDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "balanceSheetDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/balanceSheetDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -31796,7 +39296,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -31828,15 +39328,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -31863,7 +39354,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -31920,7 +39411,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -32129,6 +39620,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -32245,7 +39797,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32288,7 +39840,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -32310,6 +39862,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/barrierToInternetAccessInResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBarrierToInternetAccessInResidencesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "barrierToInternetAccessInResidenceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/barrierToInternetAccessInResidenceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBarrierToInternetAccessInResidencesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BarrierToInternetAccessInResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "barrierToInternetAccessInResidenceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/barrierToInternetAccessInResidenceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -32345,7 +40019,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -32377,15 +40051,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -32412,7 +40077,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32469,7 +40134,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -32697,6 +40362,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BehaviorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BehaviorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BehaviorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -32813,7 +40539,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -32856,7 +40582,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -32877,6 +40603,126 @@ "Discipline" ] }, + "/ed-fi/behaviorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBehaviorsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "behaviorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/behaviorDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBehaviorsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BehaviorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "behaviorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/behaviorDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -32912,7 +40758,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -32944,15 +40790,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -32979,7 +40816,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -33036,7 +40873,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -33522,6 +41359,67 @@ "schoolId" ], "type": "object" + }, + "EdFi_BellSchedule_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BellSchedule_TrackedChangeKey": { + "properties": { + "bellScheduleName": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "bellScheduleName", + "schoolId" + ], + "type": "object" + }, + "EdFi_BellSchedule_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -33636,7 +41534,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -33679,7 +41577,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -33700,6 +41598,126 @@ "BellSchedule" ] }, + "/ed-fi/bellSchedules/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBellSchedulesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "bellSchedules" + ] + }, + "x-Ed-Fi-domains": [ + "BellSchedule" + ] + }, + "/ed-fi/bellSchedules/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBellSchedulesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BellSchedule_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "bellSchedules" + ] + }, + "x-Ed-Fi-domains": [ + "BellSchedule" + ] + }, "/ed-fi/bellSchedules/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -33735,7 +41753,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -33767,15 +41785,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -33802,7 +41811,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -33859,7 +41868,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34089,6 +42098,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_BusRouteDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_BusRouteDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_BusRouteDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -34205,7 +42275,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34248,7 +42318,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34269,6 +42339,126 @@ "Enrollment" ] }, + "/ed-fi/busRouteDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getBusRoutesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "busRouteDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/busRouteDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getBusRoutesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_BusRouteDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "busRouteDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/busRouteDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -34304,7 +42494,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34336,15 +42526,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -34371,7 +42552,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34428,7 +42609,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34752,6 +42933,77 @@ "date" ], "type": "object" + }, + "EdFi_CalendarDate_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CalendarDate_TrackedChangeKey": { + "properties": { + "calendarCode": { + "maxLength": 120, + "type": "string" + }, + "date": { + "format": "date", + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "calendarCode", + "date", + "schoolId", + "schoolYear" + ], + "type": "object" + }, + "EdFi_CalendarDate_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -34852,7 +43104,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -34895,7 +43147,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34916,6 +43168,126 @@ "SchoolCalendar" ] }, + "/ed-fi/calendarDates/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarDatesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "calendarDates" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendarDates/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarDatesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarDate_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "calendarDates" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, "/ed-fi/calendarDates/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -34951,7 +43323,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -34983,15 +43355,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -35018,7 +43381,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35075,7 +43438,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -35293,6 +43656,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CalendarEventDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CalendarEventDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CalendarEventDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -35409,7 +43833,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35452,7 +43876,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -35473,6 +43897,126 @@ "SchoolCalendar" ] }, + "/ed-fi/calendarEventDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "calendarEventDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendarEventDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarEventDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "calendarEventDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, "/ed-fi/calendarEventDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -35508,7 +44052,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -35540,15 +44084,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -35575,7 +44110,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -35632,7 +44167,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -35859,6 +44394,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CalendarTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CalendarTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CalendarTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -35975,7 +44571,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36018,7 +44614,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -36039,6 +44635,126 @@ "SchoolCalendar" ] }, + "/ed-fi/calendarTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "calendarTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendarTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CalendarTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "calendarTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, "/ed-fi/calendarTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -36074,7 +44790,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -36106,15 +44822,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -36141,7 +44848,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36198,7 +44905,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -36546,6 +45253,72 @@ "schoolYear" ], "type": "object" + }, + "EdFi_Calendar_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Calendar_TrackedChangeKey": { + "properties": { + "calendarCode": { + "maxLength": 120, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "calendarCode", + "schoolId", + "schoolYear" + ], + "type": "object" + }, + "EdFi_Calendar_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -36645,7 +45418,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36688,7 +45461,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -36709,6 +45482,126 @@ "SchoolCalendar" ] }, + "/ed-fi/calendars/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "calendars" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, + "/ed-fi/calendars/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCalendarsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Calendar_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "calendars" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar" + ] + }, "/ed-fi/calendars/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -36744,7 +45637,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -36776,15 +45669,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -36811,7 +45695,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -36868,7 +45752,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -37086,6 +45970,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CandidateCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CandidateCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CandidateCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CandidateCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -37202,7 +46147,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -37245,7 +46190,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -37266,6 +46211,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/candidateCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateCharacteristicsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "candidateCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/candidateCharacteristicDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateCharacteristicsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "candidateCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/candidateCharacteristicDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -37301,7 +46366,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -37333,15 +46398,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -37368,7 +46424,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -37425,7 +46481,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38238,6 +47294,84 @@ "programTypeDescriptor" ], "type": "object" + }, + "EdFi_CandidateEducatorPreparationProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CandidateEducatorPreparationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CandidateEducatorPreparationProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "candidateIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "beginDate", + "candidateIdentifier", + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_CandidateEducatorPreparationProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateEducatorPreparationProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateEducatorPreparationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -38399,7 +47533,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38442,7 +47576,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38463,6 +47597,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/candidateEducatorPreparationProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateEducatorPreparationProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateEducatorPreparationProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "candidateEducatorPreparationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/candidateEducatorPreparationProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateEducatorPreparationProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateEducatorPreparationProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "candidateEducatorPreparationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/candidateEducatorPreparationProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -38498,7 +47752,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38530,15 +47784,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -38565,7 +47810,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -38622,7 +47867,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -38959,6 +48204,73 @@ "educationOrganizationId" ], "type": "object" + }, + "EdFi_CandidateIdentificationCode_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CandidateIdentificationCode_TrackedChangeKey": { + "properties": { + "candidateIdentificationSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "candidateIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "candidateIdentificationSystemDescriptor", + "candidateIdentifier", + "educationOrganizationId" + ], + "type": "object" + }, + "EdFi_CandidateIdentificationCode_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationCode_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -39068,7 +48380,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39111,7 +48423,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -39132,6 +48444,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/candidateIdentificationCodes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateIdentificationCodesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationCode_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "candidateIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/candidateIdentificationCodes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateIdentificationCodesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationCode_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "candidateIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/candidateIdentificationCodes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -39167,7 +48599,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -39199,15 +48631,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -39234,7 +48657,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39291,7 +48714,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -39515,6 +48938,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CandidateIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CandidateIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CandidateIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -39631,7 +49115,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39674,7 +49158,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -39695,6 +49179,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/candidateIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateIdentificationSystemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "candidateIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/candidateIdentificationSystemDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateIdentificationSystemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "candidateIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/candidateIdentificationSystemDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -39730,7 +49334,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -39762,15 +49366,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -39797,7 +49392,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -39854,7 +49449,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -40155,6 +49750,68 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_CandidateRelationshipToStaffAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CandidateRelationshipToStaffAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CandidateRelationshipToStaffAssociation_TrackedChangeKey": { + "properties": { + "candidateIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "candidateIdentifier", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_CandidateRelationshipToStaffAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateRelationshipToStaffAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CandidateRelationshipToStaffAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -40263,7 +49920,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -40306,7 +49963,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -40327,6 +49984,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/candidateRelationshipToStaffAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateRelationshipToStaffAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateRelationshipToStaffAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "candidateRelationshipToStaffAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/candidateRelationshipToStaffAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCandidateRelationshipToStaffAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CandidateRelationshipToStaffAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "candidateRelationshipToStaffAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/candidateRelationshipToStaffAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -40362,7 +50139,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -40394,15 +50171,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -40429,7 +50197,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -40486,7 +50254,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -43534,6 +53302,63 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "EdFi_Candidate_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Candidate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Candidate_TrackedChangeKey": { + "properties": { + "candidateIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "candidateIdentifier" + ], + "type": "object" + }, + "EdFi_Candidate_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Candidate_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Candidate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -43885,7 +53710,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -43928,7 +53753,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -43949,6 +53774,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/candidates/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCandidatesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Candidate_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "candidates" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/candidates/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCandidatesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Candidate_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "candidates" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/candidates/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -43984,7 +53929,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44016,15 +53961,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -44051,7 +53987,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44108,7 +54044,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44506,6 +54442,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CareerPathwayDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CareerPathwayDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CareerPathwayDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -44622,7 +54619,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44665,7 +54662,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44692,6 +54689,138 @@ "StudentTranscript" ] }, + "/ed-fi/careerPathwayDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCareerPathwaysDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "careerPathwayDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/careerPathwayDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCareerPathwaysKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CareerPathwayDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "careerPathwayDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/careerPathwayDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -44727,7 +54856,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -44759,15 +54888,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -44794,7 +54914,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -44851,7 +54971,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -45317,6 +55437,83 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "EdFi_CertificationExamResult_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamResult_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CertificationExamResult_TrackedChangeKey": { + "properties": { + "certificationExamDate": { + "format": "date", + "type": "string" + }, + "certificationExamIdentifier": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "certificationExamDate", + "certificationExamIdentifier", + "namespace", + "personId", + "sourceSystemDescriptor" + ], + "type": "object" + }, + "EdFi_CertificationExamResult_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamResult_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamResult_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -45504,7 +55701,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -45547,7 +55744,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -45568,6 +55765,126 @@ "Credential" ] }, + "/ed-fi/certificationExamResults/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationExamResultsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationExamResult_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certificationExamResults" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/certificationExamResults/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationExamResultsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationExamResult_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certificationExamResults" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/certificationExamResults/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -45603,7 +55920,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -45635,15 +55952,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -45670,7 +55978,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -45727,7 +56035,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -46002,6 +56310,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CertificationExamStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CertificationExamStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CertificationExamStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -46118,7 +56487,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46161,7 +56530,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -46182,6 +56551,126 @@ "Credential" ] }, + "/ed-fi/certificationExamStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationExamStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationExamStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certificationExamStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/certificationExamStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationExamStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationExamStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certificationExamStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/certificationExamStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -46217,7 +56706,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -46249,15 +56738,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -46284,7 +56764,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46341,7 +56821,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -46568,6 +57048,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CertificationExamTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CertificationExamTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CertificationExamTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExamTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -46684,7 +57225,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46727,7 +57268,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -46748,6 +57289,126 @@ "Credential" ] }, + "/ed-fi/certificationExamTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationExamTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationExamTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certificationExamTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/certificationExamTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationExamTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationExamTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certificationExamTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/certificationExamTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -46783,7 +57444,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -46815,15 +57476,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -46850,7 +57502,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -46907,7 +57559,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -47234,6 +57886,68 @@ "namespace" ], "type": "object" + }, + "EdFi_CertificationExam_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExam_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CertificationExam_TrackedChangeKey": { + "properties": { + "certificationExamIdentifier": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "certificationExamIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_CertificationExam_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExam_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationExam_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -47362,7 +58076,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47405,7 +58119,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -47426,6 +58140,126 @@ "Credential" ] }, + "/ed-fi/certificationExams/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationExamsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationExam_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certificationExams" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/certificationExams/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationExamsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationExam_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certificationExams" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/certificationExams/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -47461,7 +58295,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -47493,15 +58327,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -47528,7 +58353,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47585,7 +58410,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -47818,6 +58643,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CertificationFieldDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CertificationFieldDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CertificationFieldDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CertificationFieldDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationFieldDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationFieldDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -47934,7 +58820,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -47977,7 +58863,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -47998,6 +58884,126 @@ "Credential" ] }, + "/ed-fi/certificationFieldDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationFieldsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationFieldDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certificationFieldDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/certificationFieldDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationFieldsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationFieldDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certificationFieldDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/certificationFieldDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -48033,7 +59039,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48065,15 +59071,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -48100,7 +59097,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -48157,7 +59154,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48384,6 +59381,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CertificationLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CertificationLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CertificationLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CertificationLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -48500,7 +59558,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -48543,7 +59601,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48564,6 +59622,126 @@ "Credential" ] }, + "/ed-fi/certificationLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certificationLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/certificationLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certificationLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/certificationLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -48599,7 +59777,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48631,15 +59809,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -48666,7 +59835,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -48723,7 +59892,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -48953,6 +60122,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CertificationRouteDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CertificationRouteDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CertificationRouteDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CertificationRouteDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationRouteDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationRouteDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -49069,7 +60299,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49112,7 +60342,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -49136,6 +60366,132 @@ "Staff" ] }, + "/ed-fi/certificationRouteDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationRoutesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationRouteDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certificationRouteDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Enrollment", + "Graduation", + "Staff" + ] + }, + "/ed-fi/certificationRouteDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationRoutesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationRouteDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certificationRouteDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Enrollment", + "Graduation", + "Staff" + ] + }, "/ed-fi/certificationRouteDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -49171,7 +60527,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -49203,15 +60559,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -49238,7 +60585,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49295,7 +60642,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -49525,6 +60872,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CertificationStandardDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CertificationStandardDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CertificationStandardDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CertificationStandardDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationStandardDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CertificationStandardDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -49641,7 +61049,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49684,7 +61092,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -49705,6 +61113,126 @@ "Credential" ] }, + "/ed-fi/certificationStandardDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationStandardsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationStandardDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certificationStandardDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/certificationStandardDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationStandardsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CertificationStandardDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certificationStandardDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/certificationStandardDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -49740,7 +61268,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -49772,15 +61300,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -49807,7 +61326,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -49864,7 +61383,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -50503,6 +62022,68 @@ "namespace" ], "type": "object" + }, + "EdFi_Certification_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Certification_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Certification_TrackedChangeKey": { + "properties": { + "certificationIdentifier": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "certificationIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_Certification_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Certification_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Certification_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -50685,7 +62266,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -50728,7 +62309,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -50749,6 +62330,126 @@ "Credential" ] }, + "/ed-fi/certifications/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Certification_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "certifications" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/certifications/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCertificationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Certification_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "certifications" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/certifications/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -50784,7 +62485,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -50816,15 +62517,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -50851,7 +62543,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -50908,7 +62600,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51745,6 +63437,72 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ChartOfAccount_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ChartOfAccount_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ChartOfAccount_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -51933,7 +63691,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -51976,7 +63734,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -51997,6 +63755,126 @@ "Finance" ] }, + "/ed-fi/chartOfAccounts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getChartOfAccountsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "chartOfAccounts" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/chartOfAccounts/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getChartOfAccountsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ChartOfAccount_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "chartOfAccounts" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/chartOfAccounts/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -52032,7 +63910,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52064,15 +63942,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -52099,7 +63968,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52156,7 +64025,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52453,6 +64322,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -52569,7 +64499,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52612,7 +64542,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52646,6 +64576,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/charterApprovalAgencyTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCharterApprovalAgencyTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "charterApprovalAgencyTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/charterApprovalAgencyTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCharterApprovalAgencyTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CharterApprovalAgencyTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "charterApprovalAgencyTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/charterApprovalAgencyTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -52681,7 +64757,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -52713,15 +64789,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -52748,7 +64815,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -52805,7 +64872,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53058,6 +65125,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CharterStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CharterStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CharterStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -53174,7 +65302,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53217,7 +65345,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53251,6 +65379,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/charterStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCharterStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "charterStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/charterStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCharterStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CharterStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "charterStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/charterStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -53286,7 +65560,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53318,15 +65592,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -53353,7 +65618,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53410,7 +65675,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53655,6 +65920,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CitizenshipStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CitizenshipStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CitizenshipStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -53771,7 +66097,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53814,7 +66140,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53840,6 +66166,136 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/citizenshipStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCitizenshipStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "citizenshipStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "Staff", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/citizenshipStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCitizenshipStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CitizenshipStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "citizenshipStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "Staff", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/citizenshipStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -53875,7 +66331,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -53907,15 +66363,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -53942,7 +66389,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -53999,7 +66446,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54319,6 +66766,67 @@ "schoolId" ], "type": "object" + }, + "EdFi_ClassPeriod_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ClassPeriod_TrackedChangeKey": { + "properties": { + "classPeriodName": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "classPeriodName", + "schoolId" + ], + "type": "object" + }, + "EdFi_ClassPeriod_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -54407,7 +66915,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54450,7 +66958,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54473,6 +66981,130 @@ "SectionsAndPrograms" ] }, + "/ed-fi/classPeriods/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getClassPeriodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "classPeriods" + ] + }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/classPeriods/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getClassPeriodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ClassPeriod_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "classPeriods" + ] + }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/classPeriods/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -54508,7 +67140,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54540,15 +67172,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -54575,7 +67198,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -54632,7 +67255,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -54850,6 +67473,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ClassroomPositionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ClassroomPositionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ClassroomPositionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -54966,7 +67650,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55009,7 +67693,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55033,6 +67717,132 @@ "SectionsAndPrograms" ] }, + "/ed-fi/classroomPositionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getClassroomPositionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "classroomPositionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/classroomPositionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getClassroomPositionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ClassroomPositionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "classroomPositionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/classroomPositionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -55068,7 +67878,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55100,15 +67910,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -55135,7 +67936,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55192,7 +67993,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55423,6 +68224,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CohortScopeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CohortScopeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CohortScopeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -55539,7 +68401,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55582,7 +68444,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55604,6 +68466,128 @@ "StudentCohort" ] }, + "/ed-fi/cohortScopeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortScopesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "cohortScopeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/cohortScopeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortScopesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortScopeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "cohortScopeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/cohortScopeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -55639,7 +68623,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55671,15 +68655,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -55706,7 +68681,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -55763,7 +68738,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -55992,6 +68967,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CohortTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CohortTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CohortTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -56108,7 +69144,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56151,7 +69187,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56173,6 +69209,128 @@ "StudentCohort" ] }, + "/ed-fi/cohortTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "cohortTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/cohortTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "cohortTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/cohortTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -56208,7 +69366,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56240,15 +69398,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -56275,7 +69424,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56332,7 +69481,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56562,6 +69711,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CohortYearTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CohortYearTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CohortYearTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -56678,7 +69888,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56721,7 +69931,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56744,6 +69954,130 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/cohortYearTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortYearTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "cohortYearTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/cohortYearTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortYearTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CohortYearTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "cohortYearTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/cohortYearTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -56779,7 +70113,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -56811,15 +70145,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -56846,7 +70171,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -56903,7 +70228,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -57298,6 +70623,67 @@ "educationOrganizationId" ], "type": "object" + }, + "EdFi_Cohort_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Cohort_TrackedChangeKey": { + "properties": { + "cohortIdentifier": { + "maxLength": 36, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "cohortIdentifier", + "educationOrganizationId" + ], + "type": "object" + }, + "EdFi_Cohort_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -57414,7 +70800,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -57457,7 +70843,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -57479,6 +70865,128 @@ "StudentCohort" ] }, + "/ed-fi/cohorts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCohortsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "cohorts" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/cohorts/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCohortsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Cohort_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "cohorts" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/cohorts/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -57514,7 +71022,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -57546,15 +71054,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -57581,7 +71080,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -57638,7 +71137,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -58609,6 +72108,62 @@ ], "type": "object" }, + "EdFi_CommunityOrganization_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CommunityOrganization_TrackedChangeKey": { + "properties": { + "communityOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "communityOrganizationId" + ], + "type": "object" + }, + "EdFi_CommunityOrganization_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_EducationOrganization_Address": { "properties": { "addressTypeDescriptor": { @@ -58999,7 +72554,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59042,7 +72597,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -59063,6 +72618,126 @@ "EducationOrganization" ] }, + "/ed-fi/communityOrganizations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityOrganizationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "communityOrganizations" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityOrganizations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityOrganizationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityOrganization_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "communityOrganizations" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/communityOrganizations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -59098,7 +72773,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -59130,15 +72805,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -59165,7 +72831,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59222,7 +72888,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -59640,6 +73306,72 @@ "licensingOrganization" ], "type": "object" + }, + "EdFi_CommunityProviderLicense_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CommunityProviderLicense_TrackedChangeKey": { + "properties": { + "communityProviderId": { + "format": "int64", + "type": "integer" + }, + "licenseIdentifier": { + "maxLength": 36, + "type": "string" + }, + "licensingOrganization": { + "maxLength": 75, + "type": "string" + } + }, + "required": [ + "communityProviderId", + "licenseIdentifier", + "licensingOrganization" + ], + "type": "object" + }, + "EdFi_CommunityProviderLicense_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -59802,7 +73534,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -59845,7 +73577,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -59866,6 +73598,126 @@ "EducationOrganization" ] }, + "/ed-fi/communityProviderLicenses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProviderLicensesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "communityProviderLicenses" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityProviderLicenses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProviderLicensesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProviderLicense_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "communityProviderLicenses" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/communityProviderLicenses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -59901,7 +73753,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -59933,15 +73785,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -59968,7 +73811,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -60025,7 +73868,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -61153,6 +74996,62 @@ ], "type": "object" }, + "EdFi_CommunityProvider_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CommunityProvider_TrackedChangeKey": { + "properties": { + "communityProviderId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "communityProviderId" + ], + "type": "object" + }, + "EdFi_CommunityProvider_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_EducationOrganization_Address": { "properties": { "addressTypeDescriptor": { @@ -61596,7 +75495,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -61639,7 +75538,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -61660,6 +75559,126 @@ "EducationOrganization" ] }, + "/ed-fi/communityProviders/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProvidersDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "communityProviders" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/communityProviders/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCommunityProvidersKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CommunityProvider_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "communityProviders" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/communityProviders/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -61695,7 +75714,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -61727,15 +75746,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -61762,7 +75772,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -61819,7 +75829,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62096,6 +76106,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CompetencyLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CompetencyLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CompetencyLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -62212,7 +76283,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62255,7 +76326,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62283,6 +76354,140 @@ "StudentTranscript" ] }, + "/ed-fi/competencyLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "competencyLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/competencyLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "competencyLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/competencyLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -62318,7 +76523,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62350,15 +76555,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -62385,7 +76581,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62442,7 +76638,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62759,6 +76955,72 @@ "objectiveGradeLevelDescriptor" ], "type": "object" + }, + "EdFi_CompetencyObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CompetencyObjective_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "objective": { + "maxLength": 60, + "type": "string" + }, + "objectiveGradeLevelDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "objective", + "objectiveGradeLevelDescriptor" + ], + "type": "object" + }, + "EdFi_CompetencyObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -62876,7 +77138,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -62919,7 +77181,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -62941,6 +77203,128 @@ "ReportCard" ] }, + "/ed-fi/competencyObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyObjectivesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "competencyObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/competencyObjectives/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCompetencyObjectivesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CompetencyObjective_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "competencyObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, "/ed-fi/competencyObjectives/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -62976,7 +77360,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63008,15 +77392,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -63043,7 +77418,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63100,7 +77475,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63412,6 +77787,72 @@ "educationOrganizationId" ], "type": "object" + }, + "EdFi_ContactIdentificationCode_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContactIdentificationCode_TrackedChangeKey": { + "properties": { + "contactIdentificationSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "contactUniqueId": { + "maxLength": 32, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "contactIdentificationSystemDescriptor", + "contactUniqueId", + "educationOrganizationId" + ], + "type": "object" + }, + "EdFi_ContactIdentificationCode_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationCode_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -63520,7 +77961,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63563,7 +78004,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63584,6 +78025,126 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/contactIdentificationCodes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContactIdentificationCodesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationCode_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "contactIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/contactIdentificationCodes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContactIdentificationCodesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationCode_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "contactIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/contactIdentificationCodes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -63619,7 +78180,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63651,15 +78212,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -63686,7 +78238,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -63743,7 +78295,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -63968,6 +78520,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ContactIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContactIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ContactIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -64084,7 +78697,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -64127,7 +78740,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -64148,6 +78761,126 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/contactIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContactIdentificationSystemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "contactIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/contactIdentificationSystemDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContactIdentificationSystemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContactIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "contactIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/contactIdentificationSystemDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -64183,7 +78916,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -64215,15 +78948,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -64250,7 +78974,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -64307,7 +79031,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66103,6 +80827,62 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "EdFi_Contact_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Contact_TrackedChangeKey": { + "properties": { + "contactUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "contactUniqueId" + ], + "type": "object" + }, + "EdFi_Contact_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -66301,7 +81081,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66344,7 +81124,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66366,6 +81146,128 @@ "Survey" ] }, + "/ed-fi/contacts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContactsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "contacts" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics", + "Survey" + ] + }, + "/ed-fi/contacts/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContactsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Contact_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "contacts" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics", + "Survey" + ] + }, "/ed-fi/contacts/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -66401,7 +81303,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66433,15 +81335,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -66468,7 +81361,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66525,7 +81418,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66814,6 +81707,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ContentClassDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContentClassDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ContentClassDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -66930,7 +81884,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -66973,7 +81927,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -66993,6 +81947,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/contentClassDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContentClassesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "contentClassDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/contentClassDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContentClassesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContentClassDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "contentClassDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/contentClassDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -67028,7 +82100,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67060,15 +82132,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -67095,7 +82158,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67152,7 +82215,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67378,6 +82441,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -67494,7 +82618,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67537,7 +82661,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67558,6 +82682,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/continuationOfServicesReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getContinuationOfServicesReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "continuationOfServicesReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/continuationOfServicesReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getContinuationOfServicesReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ContinuationOfServicesReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "continuationOfServicesReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/continuationOfServicesReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -67593,7 +82837,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67625,15 +82869,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -67660,7 +82895,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -67717,7 +82952,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -67944,6 +83179,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CostRateDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CostRateDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CostRateDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -68060,7 +83356,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68103,7 +83399,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68124,6 +83420,126 @@ "Intervention" ] }, + "/ed-fi/costRateDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCostRatesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "costRateDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/costRateDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCostRatesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CostRateDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "costRateDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, "/ed-fi/costRateDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -68159,7 +83575,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68191,15 +83607,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -68226,7 +83633,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68283,7 +83690,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68510,6 +83917,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CoteachingStyleObservedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CoteachingStyleObservedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CoteachingStyleObservedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CoteachingStyleObservedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CoteachingStyleObservedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CoteachingStyleObservedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -68626,7 +84094,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68669,7 +84137,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68690,6 +84158,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/coteachingStyleObservedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCoteachingStyleObservedsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CoteachingStyleObservedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "coteachingStyleObservedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/coteachingStyleObservedDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCoteachingStyleObservedsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CoteachingStyleObservedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "coteachingStyleObservedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/coteachingStyleObservedDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -68725,7 +84313,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -68757,15 +84345,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -68792,7 +84371,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -68849,7 +84428,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69103,6 +84682,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CountryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CountryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CountryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -69219,7 +84859,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69262,7 +84902,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69310,6 +84950,180 @@ "StudentTranscript" ] }, + "/ed-fi/countryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCountriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "countryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "AssessmentRegistration", + "BellSchedule", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/countryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCountriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CountryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "countryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "AssessmentRegistration", + "BellSchedule", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/countryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -69345,7 +85159,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69377,15 +85191,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -69412,7 +85217,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69469,7 +85274,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69726,6 +85531,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseAttemptResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseAttemptResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseAttemptResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -69842,7 +85708,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -69885,7 +85751,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69909,6 +85775,132 @@ "StudentTranscript" ] }, + "/ed-fi/courseAttemptResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseAttemptResultsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courseAttemptResultDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courseAttemptResultDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseAttemptResultsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseAttemptResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courseAttemptResultDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/courseAttemptResultDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -69944,7 +85936,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -69976,15 +85968,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -70011,7 +85994,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70068,7 +86051,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70304,6 +86287,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseDefinedByDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseDefinedByDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseDefinedByDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -70420,7 +86464,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70463,7 +86507,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70490,6 +86534,138 @@ "StudentTranscript" ] }, + "/ed-fi/courseDefinedByDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseDefinedBiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courseDefinedByDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courseDefinedByDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseDefinedBiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseDefinedByDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courseDefinedByDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/courseDefinedByDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -70525,7 +86701,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70557,15 +86733,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -70592,7 +86759,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -70649,7 +86816,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -70888,6 +87055,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -71004,7 +87232,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71047,7 +87275,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -71074,6 +87302,138 @@ "StudentTranscript" ] }, + "/ed-fi/courseGPAApplicabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseGPAApplicabilitiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courseGPAApplicabilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courseGPAApplicabilityDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseGPAApplicabilitiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseGpaApplicabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courseGPAApplicabilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/courseGPAApplicabilityDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -71109,7 +87469,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -71141,15 +87501,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -71176,7 +87527,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71233,7 +87584,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -71472,6 +87823,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -71588,7 +88000,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71631,7 +88043,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -71658,6 +88070,138 @@ "StudentTranscript" ] }, + "/ed-fi/courseIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseIdentificationSystemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courseIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courseIdentificationSystemDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseIdentificationSystemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courseIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/courseIdentificationSystemDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -71693,7 +88237,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -71725,15 +88269,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -71760,7 +88295,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -71817,7 +88352,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72064,6 +88599,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -72180,7 +88776,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72223,7 +88819,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72258,6 +88854,154 @@ "StudentTranscript" ] }, + "/ed-fi/courseLevelCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseLevelCharacteristicsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courseLevelCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courseLevelCharacteristicDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseLevelCharacteristicsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseLevelCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courseLevelCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/courseLevelCharacteristicDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -72293,7 +89037,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72325,15 +89069,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -72360,7 +89095,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -72417,7 +89152,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -72993,6 +89728,77 @@ "sessionName" ], "type": "object" + }, + "EdFi_CourseOffering_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseOffering_TrackedChangeKey": { + "properties": { + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sessionName" + ], + "type": "object" + }, + "EdFi_CourseOffering_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -73131,7 +89937,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73174,7 +89980,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -73198,6 +90004,132 @@ "SectionsAndPrograms" ] }, + "/ed-fi/courseOfferings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseOfferingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courseOfferings" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/courseOfferings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseOfferingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseOffering_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courseOfferings" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/courseOfferings/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -73233,7 +90165,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -73265,15 +90197,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -73300,7 +90223,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73357,7 +90280,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -73609,6 +90532,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CourseRepeatCodeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CourseRepeatCodeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -73725,7 +90709,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73768,7 +90752,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -73792,6 +90776,132 @@ "StudentTranscript" ] }, + "/ed-fi/courseRepeatCodeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseRepeatCodesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courseRepeatCodeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courseRepeatCodeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseRepeatCodesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseRepeatCodeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courseRepeatCodeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/courseRepeatCodeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -73827,7 +90937,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -73859,15 +90969,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -73894,7 +90995,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -73951,7 +91052,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -75351,6 +92452,92 @@ "sectionReference" ], "type": "object" + }, + "EdFi_CourseTranscript_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CourseTranscript_TrackedChangeKey": { + "properties": { + "courseAttemptResultDescriptor": { + "maxLength": 306, + "type": "string" + }, + "courseCode": { + "maxLength": 120, + "type": "string" + }, + "courseEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "courseAttemptResultDescriptor", + "courseCode", + "courseEducationOrganizationId", + "educationOrganizationId", + "schoolYear", + "studentUniqueId", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_CourseTranscript_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -75646,7 +92833,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -75689,7 +92876,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -75713,6 +92900,132 @@ "StudentTranscript" ] }, + "/ed-fi/courseTranscripts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCourseTranscriptsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courseTranscripts" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courseTranscripts/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCourseTranscriptsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CourseTranscript_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courseTranscripts" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/courseTranscripts/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -75748,7 +93061,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -75780,15 +93093,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -75815,7 +93119,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -75872,7 +93176,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -76970,6 +94274,67 @@ "educationOrganizationId" ], "type": "object" + }, + "EdFi_Course_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Course_TrackedChangeKey": { + "properties": { + "courseCode": { + "maxLength": 120, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "courseCode", + "educationOrganizationId" + ], + "type": "object" + }, + "EdFi_Course_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -77193,7 +94558,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77236,7 +94601,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77263,6 +94628,138 @@ "StudentTranscript" ] }, + "/ed-fi/courses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCoursesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "courses" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/courses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCoursesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Course_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "courses" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/courses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -77298,7 +94795,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77330,15 +94827,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -77365,7 +94853,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77422,7 +94910,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77736,6 +95224,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CredentialEventTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CredentialEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CredentialEventTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CredentialEventTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialEventTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -77852,7 +95401,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -77895,7 +95444,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77916,6 +95465,126 @@ "Credential" ] }, + "/ed-fi/credentialEventTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialEventTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialEventTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "credentialEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/credentialEventTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialEventTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialEventTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "credentialEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/credentialEventTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -77951,7 +95620,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -77983,15 +95652,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -78018,7 +95678,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78075,7 +95735,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78367,6 +96027,77 @@ "credentialEventTypeDescriptor" ], "type": "object" + }, + "EdFi_CredentialEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CredentialEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CredentialEvent_TrackedChangeKey": { + "properties": { + "credentialEventDate": { + "format": "date", + "type": "string" + }, + "credentialEventTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "credentialIdentifier": { + "maxLength": 120, + "type": "string" + }, + "stateOfIssueStateAbbreviationDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "credentialEventDate", + "credentialEventTypeDescriptor", + "credentialIdentifier", + "stateOfIssueStateAbbreviationDescriptor" + ], + "type": "object" + }, + "EdFi_CredentialEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -78476,7 +96207,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78519,7 +96250,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78540,6 +96271,126 @@ "Credential" ] }, + "/ed-fi/credentialEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "credentialEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/credentialEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "credentialEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/credentialEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -78575,7 +96426,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78607,15 +96458,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -78642,7 +96484,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -78699,7 +96541,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -78920,6 +96762,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CredentialFieldDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CredentialFieldDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CredentialFieldDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -79036,7 +96939,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79079,7 +96982,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79101,6 +97004,128 @@ "Staff" ] }, + "/ed-fi/credentialFieldDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialFieldsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "credentialFieldDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, + "/ed-fi/credentialFieldDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialFieldsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialFieldDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "credentialFieldDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, "/ed-fi/credentialFieldDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -79136,7 +97161,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79168,15 +97193,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -79203,7 +97219,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79260,7 +97276,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79489,6 +97505,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CredentialStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CredentialStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CredentialStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CredentialStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -79605,7 +97682,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79648,7 +97725,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79670,6 +97747,128 @@ "Staff" ] }, + "/ed-fi/credentialStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "credentialStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, + "/ed-fi/credentialStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "credentialStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, "/ed-fi/credentialStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -79705,7 +97904,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -79737,15 +97936,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -79772,7 +97962,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -79829,7 +98019,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -80058,6 +98248,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CredentialTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CredentialTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CredentialTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -80174,7 +98425,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80217,7 +98468,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -80239,6 +98490,128 @@ "Staff" ] }, + "/ed-fi/credentialTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "credentialTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, + "/ed-fi/credentialTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CredentialTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "credentialTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, "/ed-fi/credentialTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -80274,7 +98647,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -80306,15 +98679,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -80341,7 +98705,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -80398,7 +98762,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81248,6 +99612,67 @@ "studentAcademicRecordReference" ], "type": "object" + }, + "EdFi_Credential_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Credential_TrackedChangeKey": { + "properties": { + "credentialIdentifier": { + "maxLength": 120, + "type": "string" + }, + "stateOfIssueStateAbbreviationDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "credentialIdentifier", + "stateOfIssueStateAbbreviationDescriptor" + ], + "type": "object" + }, + "EdFi_Credential_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -81496,7 +99921,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81539,7 +99964,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81561,6 +99986,128 @@ "Staff" ] }, + "/ed-fi/credentials/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "credentials" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, + "/ed-fi/credentials/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCredentialsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Credential_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "credentials" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, "/ed-fi/credentials/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -81596,7 +100143,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -81628,15 +100175,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -81663,7 +100201,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -81720,7 +100258,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82044,6 +100582,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CreditCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CreditCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CreditCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -82160,7 +100759,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82203,7 +100802,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82229,6 +100828,136 @@ "StudentTranscript" ] }, + "/ed-fi/creditCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCreditCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "creditCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/creditCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCreditCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CreditCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "creditCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/creditCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -82264,7 +100993,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82296,15 +101025,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -82331,7 +101051,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82388,7 +101108,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82636,6 +101356,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CreditTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CreditTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CreditTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -82752,7 +101533,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82795,7 +101576,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82832,6 +101613,158 @@ "StudentTranscript" ] }, + "/ed-fi/creditTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCreditTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "creditTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Enrollment", + "Graduation", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/creditTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCreditTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CreditTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "creditTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Enrollment", + "Graduation", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/creditTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -82867,7 +101800,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -82899,15 +101832,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -82934,7 +101858,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -82991,7 +101915,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83265,6 +102189,62 @@ "crisisEventName" ], "type": "object" + }, + "EdFi_CrisisEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CrisisEvent_TrackedChangeKey": { + "properties": { + "crisisEventName": { + "maxLength": 100, + "type": "string" + } + }, + "required": [ + "crisisEventName" + ], + "type": "object" + }, + "EdFi_CrisisEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -83371,7 +102351,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83414,7 +102394,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83435,6 +102415,126 @@ "Enrollment" ] }, + "/ed-fi/crisisEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCrisisEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "crisisEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/crisisEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCrisisEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CrisisEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "crisisEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/crisisEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -83470,7 +102570,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83502,15 +102602,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -83537,7 +102628,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83594,7 +102685,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83814,6 +102905,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CrisisTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CrisisTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CrisisTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -83930,7 +103082,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -83973,7 +103125,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -83994,6 +103146,126 @@ "Enrollment" ] }, + "/ed-fi/crisisTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCrisisTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "crisisTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/crisisTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCrisisTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CrisisTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "crisisTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/crisisTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -84029,7 +103301,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84061,15 +103333,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -84096,7 +103359,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84153,7 +103416,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84380,6 +103643,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CteProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CteProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CteProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -84496,7 +103820,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84539,7 +103863,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84560,6 +103884,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/cteProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCTEProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "cteProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/cteProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCTEProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CteProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "cteProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/cteProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -84595,7 +104039,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84627,15 +104071,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -84662,7 +104097,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -84719,7 +104154,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -84949,6 +104384,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_CurriculumUsedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_CurriculumUsedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_CurriculumUsedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -85065,7 +104561,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85108,7 +104604,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85132,6 +104628,132 @@ "SectionsAndPrograms" ] }, + "/ed-fi/curriculumUsedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getCurriculumUsedsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "curriculumUsedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/curriculumUsedDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getCurriculumUsedsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_CurriculumUsedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "curriculumUsedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/curriculumUsedDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -85167,7 +104789,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85199,15 +104821,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -85234,7 +104847,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85291,7 +104904,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85521,6 +105134,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DegreeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DegreeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DegreeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DegreeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DegreeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DegreeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -85637,7 +105311,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85680,7 +105354,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85701,6 +105375,126 @@ "Credential" ] }, + "/ed-fi/degreeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDegreesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DegreeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "degreeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/degreeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDegreesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DegreeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "degreeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/degreeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -85736,7 +105530,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -85768,15 +105562,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -85803,7 +105588,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -85860,7 +105645,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86088,6 +105873,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DeliveryMethodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DeliveryMethodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DeliveryMethodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -86204,7 +106050,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86247,7 +106093,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86269,6 +106115,128 @@ "StudentCohort" ] }, + "/ed-fi/deliveryMethodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDeliveryMethodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "deliveryMethodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/deliveryMethodDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDeliveryMethodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DeliveryMethodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "deliveryMethodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/deliveryMethodDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -86304,7 +106272,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86336,15 +106304,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -86371,7 +106330,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86428,7 +106387,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86757,6 +106716,79 @@ "value" ], "type": "object" + }, + "EdFi_DescriptorMapping_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DescriptorMapping_TrackedChangeKey": { + "properties": { + "mappedNamespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "mappedValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "value": { + "maxLength": 50, + "type": "string" + } + }, + "required": [ + "mappedNamespace", + "mappedValue", + "namespace", + "value" + ], + "type": "object" + }, + "EdFi_DescriptorMapping_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -86859,7 +106891,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -86902,7 +106934,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86923,6 +106955,126 @@ "EducationOrganization" ] }, + "/ed-fi/descriptorMappings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDescriptorMappingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "descriptorMappings" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/descriptorMappings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDescriptorMappingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DescriptorMapping_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "descriptorMappings" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/descriptorMappings/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -86958,7 +107110,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -86990,15 +107142,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -87025,7 +107168,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87082,7 +107225,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87298,6 +107441,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DiagnosisDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DiagnosisDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DiagnosisDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -87414,7 +107618,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87457,7 +107661,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87479,6 +107683,128 @@ "StudentCohort" ] }, + "/ed-fi/diagnosisDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDiagnosesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "diagnosisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/diagnosisDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDiagnosesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiagnosisDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "diagnosisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/diagnosisDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -87514,7 +107840,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87546,15 +107872,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -87581,7 +107898,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -87638,7 +107955,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -87870,6 +108187,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DiplomaLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DiplomaLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DiplomaLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -87986,7 +108364,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88029,7 +108407,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -88054,6 +108432,134 @@ "StudentTranscript" ] }, + "/ed-fi/diplomaLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "diplomaLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/diplomaLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "diplomaLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/diplomaLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -88089,7 +108595,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -88121,15 +108627,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -88156,7 +108653,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88213,7 +108710,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -88448,6 +108945,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DiplomaTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DiplomaTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DiplomaTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -88564,7 +109122,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88607,7 +109165,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -88632,6 +109190,134 @@ "StudentTranscript" ] }, + "/ed-fi/diplomaTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "diplomaTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/diplomaTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDiplomaTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DiplomaTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "diplomaTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/diplomaTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -88667,7 +109353,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -88699,15 +109385,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -88734,7 +109411,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -88791,7 +109468,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89029,6 +109706,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -89145,7 +109883,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89188,7 +109926,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89216,6 +109954,140 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/disabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilitiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "disabilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "SpecialEducation", + "SpecialEducationDataModel", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/disabilityDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilitiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "disabilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "SpecialEducation", + "SpecialEducationDataModel", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/disabilityDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -89251,7 +110123,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89283,15 +110155,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -89318,7 +110181,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89375,7 +110238,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89616,6 +110479,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisabilityDesignationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisabilityDesignationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisabilityDesignationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -89732,7 +110656,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89775,7 +110699,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89803,6 +110727,140 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/disabilityDesignationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDesignationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "disabilityDesignationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "SpecialEducation", + "SpecialEducationDataModel", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/disabilityDesignationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDesignationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDesignationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "disabilityDesignationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "SpecialEducation", + "SpecialEducationDataModel", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/disabilityDesignationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -89838,7 +110896,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -89870,15 +110928,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -89905,7 +110954,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -89962,7 +111011,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90203,6 +111252,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -90319,7 +111429,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90362,7 +111472,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90390,6 +111500,140 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/disabilityDeterminationSourceTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDeterminationSourceTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "disabilityDeterminationSourceTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "SpecialEducation", + "SpecialEducationDataModel", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/disabilityDeterminationSourceTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisabilityDeterminationSourceTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisabilityDeterminationSourceTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "disabilityDeterminationSourceTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "SpecialEducation", + "SpecialEducationDataModel", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/disabilityDeterminationSourceTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -90425,7 +111669,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90457,15 +111701,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -90492,7 +111727,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90549,7 +111784,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90783,6 +112018,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -90899,7 +112195,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -90942,7 +112238,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -90963,6 +112259,126 @@ "Discipline" ] }, + "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionLengthDifferenceReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "disciplineActionLengthDifferenceReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionLengthDifferenceReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineActionLengthDifferenceReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "disciplineActionLengthDifferenceReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/disciplineActionLengthDifferenceReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -90998,7 +112414,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -91030,15 +112446,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -91065,7 +112472,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91122,7 +112529,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -91769,6 +113176,72 @@ "studentDisciplineIncidentBehaviorAssociationReference" ], "type": "object" + }, + "EdFi_DisciplineAction_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineAction_TrackedChangeKey": { + "properties": { + "disciplineActionIdentifier": { + "maxLength": 36, + "type": "string" + }, + "disciplineDate": { + "format": "date", + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "disciplineActionIdentifier", + "disciplineDate", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_DisciplineAction_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -91922,7 +113395,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -91965,7 +113438,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -91986,6 +113459,126 @@ "Discipline" ] }, + "/ed-fi/disciplineActions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "disciplineActions" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineActions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineActionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineAction_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "disciplineActions" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/disciplineActions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -92021,7 +113614,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92053,15 +113646,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -92088,7 +113672,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92145,7 +113729,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92406,6 +113990,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisciplineDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisciplineDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -92522,7 +114167,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92565,7 +114210,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92586,6 +114231,126 @@ "Discipline" ] }, + "/ed-fi/disciplineDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplinesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "disciplineDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplinesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "disciplineDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/disciplineDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -92621,7 +114386,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92653,15 +114418,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -92688,7 +114444,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -92745,7 +114501,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -92972,6 +114728,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -93088,7 +114905,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93131,7 +114948,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93152,6 +114969,126 @@ "Discipline" ] }, + "/ed-fi/disciplineIncidentParticipationCodeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentParticipationCodesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "disciplineIncidentParticipationCodeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineIncidentParticipationCodeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentParticipationCodesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncidentParticipationCodeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "disciplineIncidentParticipationCodeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/disciplineIncidentParticipationCodeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -93187,7 +115124,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93219,15 +115156,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -93254,7 +115182,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -93311,7 +115239,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -93922,6 +115850,67 @@ ], "type": "object" }, + "EdFi_DisciplineIncident_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisciplineIncident_TrackedChangeKey": { + "properties": { + "incidentIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "incidentIdentifier", + "schoolId" + ], + "type": "object" + }, + "EdFi_DisciplineIncident_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_DisciplineIncident_Weapon": { "properties": { "weaponDescriptor": { @@ -94093,7 +116082,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94136,7 +116125,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94157,6 +116146,126 @@ "Discipline" ] }, + "/ed-fi/disciplineIncidents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "disciplineIncidents" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/disciplineIncidents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisciplineIncidentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisciplineIncident_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "disciplineIncidents" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/disciplineIncidents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -94192,7 +116301,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94224,15 +116333,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -94259,7 +116359,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94316,7 +116416,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94582,6 +116682,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DisplacedStudentStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -94698,7 +116859,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94741,7 +116902,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94763,6 +116924,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/displacedStudentStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDisplacedStudentStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "displacedStudentStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/displacedStudentStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDisplacedStudentStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DisplacedStudentStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "displacedStudentStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/displacedStudentStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -94798,7 +117081,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -94830,15 +117113,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -94865,7 +117139,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -94922,7 +117196,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95158,6 +117432,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DualCreditInstitutionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DualCreditInstitutionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DualCreditInstitutionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -95274,7 +117609,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95317,7 +117652,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95346,6 +117681,142 @@ "SectionsAndPrograms" ] }, + "/ed-fi/dualCreditInstitutionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDualCreditInstitutionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "dualCreditInstitutionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/dualCreditInstitutionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDualCreditInstitutionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DualCreditInstitutionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "dualCreditInstitutionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/dualCreditInstitutionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -95381,7 +117852,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95413,15 +117884,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -95448,7 +117910,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95505,7 +117967,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95748,6 +118210,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DualCreditTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DualCreditTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DualCreditTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -95864,7 +118387,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -95907,7 +118430,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -95936,6 +118459,142 @@ "SectionsAndPrograms" ] }, + "/ed-fi/dualCreditTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDualCreditTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "dualCreditTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/dualCreditTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDualCreditTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DualCreditTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "dualCreditTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/dualCreditTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -95971,7 +118630,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96003,15 +118662,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -96038,7 +118688,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -96095,7 +118745,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96330,6 +118980,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_DurationIntervalDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_DurationIntervalDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_DurationIntervalDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_DurationIntervalDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_DurationIntervalDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_DurationIntervalDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -96446,7 +119157,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -96489,7 +119200,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96510,6 +119221,126 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/durationIntervalDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getDurationIntervalsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DurationIntervalDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "durationIntervalDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, + "/ed-fi/durationIntervalDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getDurationIntervalsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_DurationIntervalDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "durationIntervalDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, "/ed-fi/durationIntervalDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -96545,7 +119376,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96577,15 +119408,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -96612,7 +119434,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -96669,7 +119491,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -96900,6 +119722,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EconomicDisadvantageDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EconomicDisadvantageDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EconomicDisadvantageDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EconomicDisadvantageDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EconomicDisadvantageDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EconomicDisadvantageDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -97016,7 +119899,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97059,7 +119942,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -97084,6 +119967,134 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/economicDisadvantageDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEconomicDisadvantagesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EconomicDisadvantageDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "economicDisadvantageDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/economicDisadvantageDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEconomicDisadvantagesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EconomicDisadvantageDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "economicDisadvantageDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/economicDisadvantageDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -97119,7 +120130,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -97151,15 +120162,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -97186,7 +120188,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -97243,7 +120245,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98112,6 +121114,62 @@ "contentIdentifier" ], "type": "object" + }, + "EdFi_EducationContent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationContent_TrackedChangeKey": { + "properties": { + "contentIdentifier": { + "maxLength": 225, + "type": "string" + } + }, + "required": [ + "contentIdentifier" + ], + "type": "object" + }, + "EdFi_EducationContent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -98329,7 +121387,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98372,7 +121430,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98393,6 +121451,126 @@ "Intervention" ] }, + "/ed-fi/educationContents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationContentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationContents" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/educationContents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationContentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationContent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationContents" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, "/ed-fi/educationContents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -98428,7 +121606,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98460,15 +121638,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -98495,7 +121664,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -98552,7 +121721,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -98850,6 +122019,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -98966,7 +122196,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99009,7 +122239,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -99030,6 +122260,126 @@ "Assessment" ] }, + "/ed-fi/educationOrganizationAssociationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationAssociationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationOrganizationAssociationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, + "/ed-fi/educationOrganizationAssociationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationAssociationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationAssociationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationOrganizationAssociationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, "/ed-fi/educationOrganizationAssociationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -99065,7 +122415,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -99097,15 +122447,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -99132,7 +122473,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99189,7 +122530,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -99434,6 +122775,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -99550,7 +122952,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99593,7 +122995,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -99632,6 +123034,162 @@ "StudentTranscript" ] }, + "/ed-fi/educationOrganizationCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationOrganizationCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/educationOrganizationCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationOrganizationCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/educationOrganizationCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -99667,7 +123225,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -99699,15 +123257,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -99734,7 +123283,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -99791,7 +123340,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100073,6 +123622,67 @@ "educationOrganizationIdentificationSystemDescriptor" ], "type": "object" + }, + "EdFi_EducationOrganizationIdentificationCode_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationIdentificationCode_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "educationOrganizationIdentificationSystemDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "educationOrganizationIdentificationSystemDescriptor" + ], + "type": "object" + }, + "EdFi_EducationOrganizationIdentificationCode_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationCode_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -100171,7 +123781,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100214,7 +123824,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100235,6 +123845,126 @@ "EducationOrganization" ] }, + "/ed-fi/educationOrganizationIdentificationCodes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationIdentificationCodesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationCode_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationOrganizationIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationIdentificationCodes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationIdentificationCodesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationCode_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationOrganizationIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/educationOrganizationIdentificationCodes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -100270,7 +124000,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100302,15 +124032,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -100337,7 +124058,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100394,7 +124115,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100612,6 +124333,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -100728,7 +124510,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100771,7 +124553,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100792,6 +124574,126 @@ "EducationOrganization" ] }, + "/ed-fi/educationOrganizationIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationIdentificationSystemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationOrganizationIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationIdentificationSystemDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationIdentificationSystemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationOrganizationIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/educationOrganizationIdentificationSystemDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -100827,7 +124729,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -100859,15 +124761,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -100894,7 +124787,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -100951,7 +124844,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -101248,6 +125141,72 @@ "interventionPrescriptionIdentificationCode" ], "type": "object" + }, + "EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionPrescriptionEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionPrescriptionIdentificationCode": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionPrescriptionEducationOrganizationId", + "interventionPrescriptionIdentificationCode" + ], + "type": "object" + }, + "EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -101356,7 +125315,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -101399,7 +125358,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -101420,6 +125379,126 @@ "Intervention" ] }, + "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationOrganizationInterventionPrescriptionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationInterventionPrescriptionAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationInterventionPrescriptionAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationOrganizationInterventionPrescriptionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, "/ed-fi/educationOrganizationInterventionPrescriptionAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -101455,7 +125534,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -101487,15 +125566,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -101522,7 +125592,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -101579,7 +125649,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -101858,6 +125928,67 @@ "memberEducationOrganizationId" ], "type": "object" + }, + "EdFi_EducationOrganizationNetworkAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationNetworkId": { + "format": "int64", + "type": "integer" + }, + "memberEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationOrganizationNetworkId", + "memberEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -101956,7 +126087,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -101999,7 +126130,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -102020,6 +126151,126 @@ "EducationOrganization" ] }, + "/ed-fi/educationOrganizationNetworkAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworkAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationOrganizationNetworkAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationNetworkAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworkAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetworkAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationOrganizationNetworkAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/educationOrganizationNetworkAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -102055,7 +126306,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -102087,15 +126338,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -102122,7 +126364,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -102179,7 +126421,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -103159,6 +127401,62 @@ ], "type": "object" }, + "EdFi_EducationOrganizationNetwork_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetwork_TrackedChangeKey": { + "properties": { + "educationOrganizationNetworkId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationOrganizationNetworkId" + ], + "type": "object" + }, + "EdFi_EducationOrganizationNetwork_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_EducationOrganization_Address": { "properties": { "addressTypeDescriptor": { @@ -103558,7 +127856,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -103601,7 +127899,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -103622,6 +127920,126 @@ "EducationOrganization" ] }, + "/ed-fi/educationOrganizationNetworks/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworksDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationOrganizationNetworks" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationNetworks/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationNetworksKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationNetwork_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationOrganizationNetworks" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/educationOrganizationNetworks/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -103657,7 +128075,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -103689,15 +128107,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -103724,7 +128133,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -103781,7 +128190,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -104033,6 +128442,67 @@ "peerEducationOrganizationId" ], "type": "object" + }, + "EdFi_EducationOrganizationPeerAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "peerEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationOrganizationId", + "peerEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_EducationOrganizationPeerAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -104113,7 +128583,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104156,7 +128626,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -104177,6 +128647,126 @@ "EducationOrganization" ] }, + "/ed-fi/educationOrganizationPeerAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationPeerAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationOrganizationPeerAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/educationOrganizationPeerAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationOrganizationPeerAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationOrganizationPeerAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationOrganizationPeerAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/educationOrganizationPeerAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -104212,7 +128802,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -104244,15 +128834,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -104279,7 +128860,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104336,7 +128917,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -104551,6 +129132,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationPlanDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationPlanDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationPlanDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -104667,7 +129309,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104710,7 +129352,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -104735,6 +129377,134 @@ "SectionsAndPrograms" ] }, + "/ed-fi/educationPlanDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationPlansDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationPlanDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/educationPlanDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationPlansKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationPlanDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationPlanDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/educationPlanDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -104770,7 +129540,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -104802,15 +129572,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -104837,7 +129598,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -104894,7 +129655,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106178,6 +130939,62 @@ "educationServiceCenterId" ], "type": "object" + }, + "EdFi_EducationServiceCenter_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationServiceCenter_TrackedChangeKey": { + "properties": { + "educationServiceCenterId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "educationServiceCenterId" + ], + "type": "object" + }, + "EdFi_EducationServiceCenter_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -106295,7 +131112,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106338,7 +131155,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106360,6 +131177,128 @@ "Staff" ] }, + "/ed-fi/educationServiceCenters/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationServiceCentersDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationServiceCenters" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, + "/ed-fi/educationServiceCenters/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationServiceCentersKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationServiceCenter_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationServiceCenters" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, "/ed-fi/educationServiceCenters/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -106395,7 +131334,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106427,15 +131366,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -106462,7 +131392,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106519,7 +131449,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106773,6 +131703,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducationalEnvironmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducationalEnvironmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -106889,7 +131880,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -106932,7 +131923,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -106966,6 +131957,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/educationalEnvironmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducationalEnvironmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educationalEnvironmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Intervention", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/educationalEnvironmentDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducationalEnvironmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducationalEnvironmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educationalEnvironmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Intervention", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/educationalEnvironmentDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -107001,7 +132138,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107033,15 +132170,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -107068,7 +132196,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107125,7 +132253,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107490,6 +132618,73 @@ "programTypeDescriptor" ], "type": "object" + }, + "EdFi_EducatorPreparationProgram_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducatorPreparationProgram_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducatorPreparationProgram_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_EducatorPreparationProgram_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducatorPreparationProgram_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducatorPreparationProgram_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -107599,7 +132794,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107642,7 +132837,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107663,6 +132858,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/educatorPreparationPrograms/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducatorPreparationProgramsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducatorPreparationProgram_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educatorPreparationPrograms" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/educatorPreparationPrograms/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducatorPreparationProgramsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducatorPreparationProgram_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educatorPreparationPrograms" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/educatorPreparationPrograms/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -107698,7 +133013,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -107730,15 +133045,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -107765,7 +133071,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -107822,7 +133128,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108047,6 +133353,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EducatorRoleDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EducatorRoleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EducatorRoleDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EducatorRoleDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EducatorRoleDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EducatorRoleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -108163,7 +133530,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108206,7 +133573,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108228,6 +133595,128 @@ "Staff" ] }, + "/ed-fi/educatorRoleDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEducatorRolesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducatorRoleDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "educatorRoleDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, + "/ed-fi/educatorRoleDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEducatorRolesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EducatorRoleDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "educatorRoleDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, "/ed-fi/educatorRoleDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -108263,7 +133752,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108295,15 +133784,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -108330,7 +133810,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108387,7 +133867,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108620,6 +134100,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ElectronicMailTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ElectronicMailTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -108736,7 +134277,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108779,7 +134320,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108805,6 +134346,136 @@ "Survey" ] }, + "/ed-fi/electronicMailTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getElectronicMailTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "electronicMailTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "Staff", + "StudentIdentificationAndDemographics", + "Survey" + ] + }, + "/ed-fi/electronicMailTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getElectronicMailTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ElectronicMailTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "electronicMailTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "Staff", + "StudentIdentificationAndDemographics", + "Survey" + ] + }, "/ed-fi/electronicMailTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -108840,7 +134511,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -108872,15 +134543,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -108907,7 +134569,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -108964,7 +134626,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109196,6 +134858,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EligibilityDelayReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -109312,7 +135035,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109355,7 +135078,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109376,6 +135099,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/eligibilityDelayReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityDelayReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "eligibilityDelayReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/eligibilityDelayReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityDelayReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityDelayReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "eligibilityDelayReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/eligibilityDelayReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -109411,7 +135254,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109443,15 +135286,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -109478,7 +135312,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109535,7 +135369,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109762,6 +135596,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -109878,7 +135773,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -109921,7 +135816,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -109942,6 +135837,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/eligibilityEvaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityEvaluationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "eligibilityEvaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/eligibilityEvaluationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEligibilityEvaluationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EligibilityEvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "eligibilityEvaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/eligibilityEvaluationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -109977,7 +135992,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -110009,15 +136024,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -110044,7 +136050,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110101,7 +136107,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -110328,6 +136334,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EmploymentStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EmploymentStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EmploymentStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -110444,7 +136511,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110487,7 +136554,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -110508,6 +136575,126 @@ "Staff" ] }, + "/ed-fi/employmentStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEmploymentStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "employmentStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/employmentStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEmploymentStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EmploymentStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "employmentStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/employmentStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -110543,7 +136730,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -110575,15 +136762,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -110610,7 +136788,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -110667,7 +136845,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -110894,6 +137072,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EnglishLanguageExamDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EnglishLanguageExamDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EnglishLanguageExamDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EnglishLanguageExamDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EnglishLanguageExamDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EnglishLanguageExamDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -111010,7 +137249,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111053,7 +137292,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111074,6 +137313,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/englishLanguageExamDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEnglishLanguageExamsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EnglishLanguageExamDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "englishLanguageExamDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/englishLanguageExamDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEnglishLanguageExamsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EnglishLanguageExamDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "englishLanguageExamDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/englishLanguageExamDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -111109,7 +137468,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111141,15 +137500,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -111176,7 +137526,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111233,7 +137583,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111464,6 +137814,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EnrollmentTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EnrollmentTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EnrollmentTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -111580,7 +137991,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111623,7 +138034,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111648,6 +138059,134 @@ "SectionsAndPrograms" ] }, + "/ed-fi/enrollmentTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEnrollmentTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "enrollmentTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/enrollmentTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEnrollmentTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EnrollmentTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "enrollmentTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/enrollmentTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -111683,7 +138222,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -111715,15 +138254,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -111750,7 +138280,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -111807,7 +138337,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112042,6 +138572,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -112158,7 +138749,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112201,7 +138792,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112226,6 +138817,134 @@ "SectionsAndPrograms" ] }, + "/ed-fi/entryGradeLevelReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEntryGradeLevelReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "entryGradeLevelReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/entryGradeLevelReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEntryGradeLevelReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EntryGradeLevelReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "entryGradeLevelReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/entryGradeLevelReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -112261,7 +138980,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112293,15 +139012,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -112328,7 +139038,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112385,7 +139095,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112620,6 +139330,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EntryTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EntryTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EntryTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -112736,7 +139507,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112779,7 +139550,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112804,6 +139575,134 @@ "SectionsAndPrograms" ] }, + "/ed-fi/entryTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEntryTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "entryTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/entryTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEntryTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EntryTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "entryTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/entryTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -112839,7 +139738,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -112871,15 +139770,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -112906,7 +139796,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -112963,7 +139853,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -113194,6 +140084,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EppDegreeTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EppDegreeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EppDegreeTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EppDegreeTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EppDegreeTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EppDegreeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -113310,7 +140261,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -113353,7 +140304,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -113374,6 +140325,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/eppDegreeTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEPPDegreeTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EppDegreeTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "eppDegreeTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/eppDegreeTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEPPDegreeTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EppDegreeTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "eppDegreeTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/eppDegreeTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -113409,7 +140480,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -113441,15 +140512,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -113476,7 +140538,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -113533,7 +140595,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -113760,6 +140822,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EppProgramPathwayDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EppProgramPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EppProgramPathwayDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EppProgramPathwayDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EppProgramPathwayDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EppProgramPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -113876,7 +140999,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -113919,7 +141042,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -113940,6 +141063,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/eppProgramPathwayDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEPPProgramPathwaysDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EppProgramPathwayDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "eppProgramPathwayDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/eppProgramPathwayDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEPPProgramPathwaysKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EppProgramPathwayDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "eppProgramPathwayDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/eppProgramPathwayDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -113975,7 +141218,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -114007,15 +141250,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -114042,7 +141276,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114099,7 +141333,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -114326,6 +141560,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EvaluationDelayReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -114442,7 +141737,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114485,7 +141780,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -114506,6 +141801,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/evaluationDelayReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationDelayReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationDelayReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/evaluationDelayReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationDelayReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationDelayReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationDelayReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/evaluationDelayReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -114541,7 +141956,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -114573,15 +141988,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -114608,7 +142014,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -114665,7 +142071,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -114892,6 +142298,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EvaluationElementRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationElementRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EvaluationElementRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -115008,7 +142475,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -115051,7 +142518,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -115072,6 +142539,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationElementRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationElementRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationElementRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationElementRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationElementRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationElementRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationElementRatingLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -115107,7 +142694,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -115139,15 +142726,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -115174,7 +142752,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -115231,7 +142809,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -116052,6 +143630,121 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "EdFi_EvaluationElementRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationElementRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationDate": { + "format": "date-time", + "type": "string" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationDate", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_EvaluationElementRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -116285,7 +143978,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -116328,7 +144021,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -116349,6 +144042,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationElementRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationElementRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationElementRatings" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationElementRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationElementRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationElementRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationElementRatings" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationElementRatings/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -116384,7 +144197,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -116416,15 +144229,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -116451,7 +144255,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -116508,7 +144312,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -117147,6 +144951,106 @@ "evaluationObjectiveTitle" ], "type": "object" + }, + "EdFi_EvaluationElement_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationElement_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_EvaluationElement_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElement_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -117337,7 +145241,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -117380,7 +145284,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -117401,6 +145305,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationElements/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationElementsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationElement_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationElements" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationElements/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationElementsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationElement_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationElements" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationElements/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -117436,7 +145460,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -117468,15 +145492,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -117503,7 +145518,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -117560,7 +145575,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118328,6 +146343,115 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "EdFi_EvaluationObjectiveRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationObjectiveRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationObjectiveRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationDate": { + "format": "date-time", + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationDate", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_EvaluationObjectiveRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationObjectiveRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationObjectiveRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -118520,7 +146644,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118563,7 +146687,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118584,6 +146708,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationObjectiveRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationObjectiveRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationObjectiveRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationObjectiveRatings" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationObjectiveRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationObjectiveRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationObjectiveRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationObjectiveRatings" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationObjectiveRatings/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -118619,7 +146863,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -118651,15 +146895,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -118686,7 +146921,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -118743,7 +146978,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119354,6 +147589,100 @@ "evaluationObjectiveTitle" ], "type": "object" + }, + "EdFi_EvaluationObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationObjective_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_EvaluationObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -119542,7 +147871,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119585,7 +147914,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119606,6 +147935,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationObjectivesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationObjectives/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationObjectivesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationObjective_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationObjectives/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -119641,7 +148090,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -119673,15 +148122,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -119708,7 +148148,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -119765,7 +148205,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120044,6 +148484,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EvaluationPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EvaluationPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -120160,7 +148661,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120203,7 +148704,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120224,6 +148725,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationPeriodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationPeriodDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationPeriodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationPeriodDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -120259,7 +148880,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120291,15 +148912,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -120326,7 +148938,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120383,7 +148995,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120610,6 +149222,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EvaluationRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EvaluationRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -120726,7 +149399,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120769,7 +149442,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120790,6 +149463,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationRatingLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -120825,7 +149618,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -120857,15 +149650,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -120892,7 +149676,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -120949,7 +149733,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121176,6 +149960,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EvaluationRatingStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationRatingStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EvaluationRatingStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -121292,7 +150137,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121335,7 +150180,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121356,6 +150201,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationRatingStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRatingStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationRatingStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationRatingStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRatingStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRatingStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationRatingStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationRatingStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -121391,7 +150356,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -121423,15 +150388,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -121458,7 +150414,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -121515,7 +150471,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -122473,6 +151429,109 @@ "lastSurname" ], "type": "object" + }, + "EdFi_EvaluationRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationDate": { + "format": "date-time", + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationDate", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_EvaluationRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -122712,7 +151771,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122755,7 +151814,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -122776,6 +151835,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationRatings" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationRatings" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationRatings/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -122811,7 +151990,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -122843,15 +152022,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -122878,7 +152048,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -122935,7 +152105,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -123424,6 +152594,97 @@ "programEvaluationElementTitle" ], "type": "object" + }, + "EdFi_EvaluationRubricDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationRubricDimension_TrackedChangeKey": { + "properties": { + "evaluationRubricRating": { + "format": "int32", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationElementTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "evaluationRubricRating", + "programEducationOrganizationId", + "programEvaluationElementTitle", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_EvaluationRubricDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -123591,7 +152852,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123634,7 +152895,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -123656,6 +152917,128 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/evaluationRubricDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRubricDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationRubricDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/evaluationRubricDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationRubricDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationRubricDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationRubricDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/evaluationRubricDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -123691,7 +153074,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -123723,15 +153106,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -123758,7 +153132,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -123815,7 +153189,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124076,6 +153450,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -124192,7 +153627,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124235,7 +153670,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124256,6 +153691,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -124291,7 +153846,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124323,15 +153878,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -124358,7 +153904,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -124415,7 +153961,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -124949,6 +154495,94 @@ "termDescriptor" ], "type": "object" + }, + "EdFi_Evaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Evaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Evaluation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_Evaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Evaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Evaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -125126,7 +154760,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125169,7 +154803,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -125190,6 +154824,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/evaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Evaluation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluations" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/evaluations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEvaluationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Evaluation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluations" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/evaluations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -125225,7 +154979,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -125257,15 +155011,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -125292,7 +155037,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125349,7 +155094,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -125623,6 +155368,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EventCircumstanceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EventCircumstanceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EventCircumstanceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -125739,7 +155545,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125782,7 +155588,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -125804,6 +155610,128 @@ "StudentAssessment" ] }, + "/ed-fi/eventCircumstanceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEventCircumstancesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "eventCircumstanceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/eventCircumstanceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEventCircumstancesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EventCircumstanceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "eventCircumstanceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, "/ed-fi/eventCircumstanceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -125839,7 +155767,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -125871,15 +155799,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -125906,7 +155825,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -125963,7 +155882,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126191,6 +156110,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EventComplianceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EventComplianceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EventComplianceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EventComplianceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EventComplianceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EventComplianceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -126307,7 +156287,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126350,7 +156330,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126371,6 +156351,126 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/eventComplianceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEventCompliancesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EventComplianceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "eventComplianceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, + "/ed-fi/eventComplianceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEventCompliancesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EventComplianceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "eventComplianceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, "/ed-fi/eventComplianceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -126406,7 +156506,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126438,15 +156538,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -126473,7 +156564,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126530,7 +156621,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126757,6 +156848,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_EventReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_EventReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_EventReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_EventReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_EventReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_EventReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -126873,7 +157025,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -126916,7 +157068,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -126937,6 +157089,126 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/eventReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getEventReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EventReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "eventReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, + "/ed-fi/eventReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getEventReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_EventReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "eventReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, "/ed-fi/eventReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -126972,7 +157244,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127004,15 +157276,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -127039,7 +157302,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127096,7 +157359,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127327,6 +157590,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ExitWithdrawTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -127443,7 +157767,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127486,7 +157810,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127511,6 +157835,134 @@ "SectionsAndPrograms" ] }, + "/ed-fi/exitWithdrawTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getExitWithdrawTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "exitWithdrawTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/exitWithdrawTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getExitWithdrawTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ExitWithdrawTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "exitWithdrawTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/exitWithdrawTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -127546,7 +157998,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127578,15 +158030,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -127613,7 +158056,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -127670,7 +158113,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -127914,6 +158357,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_FederalLocaleCodeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FederalLocaleCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FederalLocaleCodeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_FederalLocaleCodeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FederalLocaleCodeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FederalLocaleCodeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -128030,7 +158534,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128073,7 +158577,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128107,6 +158611,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/federalLocaleCodeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFederalLocaleCodesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FederalLocaleCodeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "federalLocaleCodeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/federalLocaleCodeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFederalLocaleCodesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FederalLocaleCodeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "federalLocaleCodeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/federalLocaleCodeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -128142,7 +158792,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128174,15 +158824,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -128209,7 +158850,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128266,7 +158907,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128584,6 +159225,72 @@ "schoolId" ], "type": "object" + }, + "EdFi_FeederSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FeederSchoolAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "feederSchoolId": { + "format": "int64", + "type": "integer" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "beginDate", + "feederSchoolId", + "schoolId" + ], + "type": "object" + }, + "EdFi_FeederSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -128692,7 +159399,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128735,7 +159442,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128756,6 +159463,126 @@ "EducationOrganization" ] }, + "/ed-fi/feederSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFeederSchoolAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "feederSchoolAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/feederSchoolAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFeederSchoolAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FeederSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "feederSchoolAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/feederSchoolAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -128791,7 +159618,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -128823,15 +159650,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -128858,7 +159676,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -128915,7 +159733,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129281,6 +160099,98 @@ "sectionIdentifier" ], "type": "object" + }, + "EdFi_FieldworkExperienceSectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkExperienceSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FieldworkExperienceSectionAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "fieldworkIdentifier": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "fieldworkIdentifier", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_FieldworkExperienceSectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkExperienceSectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkExperienceSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -129422,7 +160332,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129465,7 +160375,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129486,6 +160396,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/fieldworkExperienceSectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFieldworkExperienceSectionAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FieldworkExperienceSectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "fieldworkExperienceSectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/fieldworkExperienceSectionAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFieldworkExperienceSectionAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FieldworkExperienceSectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "fieldworkExperienceSectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/fieldworkExperienceSectionAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -129521,7 +160551,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -129553,15 +160583,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -129588,7 +160609,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -129645,7 +160666,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130131,6 +161152,73 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_FieldworkExperience_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkExperience_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FieldworkExperience_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "fieldworkIdentifier": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "fieldworkIdentifier", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_FieldworkExperience_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkExperience_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkExperience_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -130290,7 +161378,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130333,7 +161421,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130354,6 +161442,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/fieldworkExperiences/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFieldworkExperiencesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FieldworkExperience_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "fieldworkExperiences" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/fieldworkExperiences/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFieldworkExperiencesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FieldworkExperience_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "fieldworkExperiences" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/fieldworkExperiences/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -130389,7 +161597,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130421,15 +161629,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -130456,7 +161655,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130513,7 +161712,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130764,6 +161963,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_FieldworkTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FieldworkTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_FieldworkTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FieldworkTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -130880,7 +162140,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -130923,7 +162183,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -130944,6 +162204,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/fieldworkTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFieldworkTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FieldworkTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "fieldworkTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/fieldworkTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFieldworkTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FieldworkTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "fieldworkTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/fieldworkTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -130979,7 +162359,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131011,15 +162391,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -131046,7 +162417,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131103,7 +162474,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131435,6 +162806,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_FinancialAid_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FinancialAid_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FinancialAid_TrackedChangeKey": { + "properties": { + "aidTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "beginDate": { + "format": "date", + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "aidTypeDescriptor", + "beginDate", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_FinancialAid_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FinancialAid_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FinancialAid_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -131560,7 +162997,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131603,7 +163040,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131624,6 +163061,126 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/financialAids/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFinancialAidsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FinancialAid_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "financialAids" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/financialAids/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFinancialAidsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FinancialAid_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "financialAids" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/financialAids/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -131659,7 +163216,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -131691,15 +163248,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -131726,7 +163274,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -131783,7 +163331,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132016,6 +163564,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_FinancialCollectionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FinancialCollectionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_FinancialCollectionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -132132,7 +163741,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132175,7 +163784,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132196,6 +163805,126 @@ "Finance" ] }, + "/ed-fi/financialCollectionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFinancialCollectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "financialCollectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/financialCollectionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFinancialCollectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FinancialCollectionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "financialCollectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/financialCollectionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -132231,7 +163960,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132263,15 +163992,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -132298,7 +164018,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132355,7 +164075,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132582,6 +164302,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_FrequencyIntervalDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FrequencyIntervalDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FrequencyIntervalDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_FrequencyIntervalDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FrequencyIntervalDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FrequencyIntervalDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -132698,7 +164479,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132741,7 +164522,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132762,6 +164543,126 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/frequencyIntervalDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFrequencyIntervalsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FrequencyIntervalDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "frequencyIntervalDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, + "/ed-fi/frequencyIntervalDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFrequencyIntervalsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FrequencyIntervalDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "frequencyIntervalDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, "/ed-fi/frequencyIntervalDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -132797,7 +164698,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -132829,15 +164730,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -132864,7 +164756,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -132921,7 +164813,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133209,6 +165101,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_FunctionDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FunctionDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_FunctionDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -133298,7 +165251,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133341,7 +165294,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133362,6 +165315,126 @@ "Finance" ] }, + "/ed-fi/functionDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFunctionDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "functionDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/functionDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFunctionDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FunctionDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "functionDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/functionDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -133397,7 +165470,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133429,15 +165502,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -133464,7 +165528,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133521,7 +165585,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133790,6 +165854,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_FundDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FundDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_FundDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -133879,7 +166004,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -133922,7 +166047,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -133943,6 +166068,126 @@ "Finance" ] }, + "/ed-fi/fundDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFundDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "fundDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/fundDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFundDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FundDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "fundDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/fundDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -133978,7 +166223,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134010,15 +166255,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -134045,7 +166281,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134102,7 +166338,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134310,6 +166546,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_FundingSourceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_FundingSourceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_FundingSourceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_FundingSourceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_FundingSourceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_FundingSourceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -134426,7 +166723,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134469,7 +166766,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134490,6 +166787,126 @@ "Staff" ] }, + "/ed-fi/fundingSourceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getFundingSourcesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FundingSourceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "fundingSourceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/fundingSourceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getFundingSourcesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_FundingSourceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "fundingSourceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/fundingSourceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -134525,7 +166942,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134557,15 +166974,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -134592,7 +167000,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -134649,7 +167057,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -134876,6 +167284,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GoalTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GoalTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GoalTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GoalTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GoalTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GoalTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -134992,7 +167461,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135035,7 +167504,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135056,6 +167525,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/goalTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGoalTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GoalTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "goalTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/goalTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGoalTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GoalTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "goalTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/goalTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -135091,7 +167680,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135123,15 +167712,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -135158,7 +167738,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -135215,7 +167795,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -135957,6 +168537,78 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "EdFi_Goal_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Goal_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Goal_TrackedChangeKey": { + "properties": { + "assignmentDate": { + "format": "date", + "type": "string" + }, + "goalTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "assignmentDate", + "goalTitle", + "personId", + "sourceSystemDescriptor" + ], + "type": "object" + }, + "EdFi_Goal_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Goal_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Goal_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -136247,7 +168899,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136290,7 +168942,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -136311,6 +168963,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/goals/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGoalsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Goal_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "goals" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/goals/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGoalsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Goal_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "goals" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/goals/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -136346,7 +169118,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -136378,15 +169150,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -136413,7 +169176,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136470,7 +169233,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -136831,6 +169594,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradeLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradeLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradeLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -136947,7 +169771,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -136990,7 +169814,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137039,6 +169863,182 @@ "StudentTranscript" ] }, + "/ed-fi/gradeLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradeLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "gradeLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "AssessmentRegistration", + "BellSchedule", + "Credential", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Graduation", + "Intervention", + "PerformanceEvaluation", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "Standards", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/gradeLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradeLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradeLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "gradeLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "AssessmentRegistration", + "BellSchedule", + "Credential", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Graduation", + "Intervention", + "PerformanceEvaluation", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "Standards", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/gradeLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -137074,7 +170074,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137106,15 +170106,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -137141,7 +170132,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137198,7 +170189,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137459,6 +170450,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradePointAverageTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradePointAverageTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -137575,7 +170627,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137618,7 +170670,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137645,6 +170697,138 @@ "StudentTranscript" ] }, + "/ed-fi/gradePointAverageTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradePointAverageTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "gradePointAverageTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation", + "RecruitingAndStaffing", + "StudentAcademicRecord", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/gradePointAverageTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradePointAverageTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradePointAverageTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "gradePointAverageTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation", + "RecruitingAndStaffing", + "StudentAcademicRecord", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/gradePointAverageTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -137680,7 +170864,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -137712,15 +170896,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -137747,7 +170922,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -137804,7 +170979,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138038,6 +171213,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradeTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradeTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradeTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -138154,7 +171390,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138197,7 +171433,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138219,6 +171455,128 @@ "ReportCard" ] }, + "/ed-fi/gradeTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradeTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "gradeTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/gradeTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradeTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradeTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "gradeTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, "/ed-fi/gradeTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -138254,7 +171612,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138286,15 +171644,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -138321,7 +171670,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -138378,7 +171727,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -138975,6 +172324,68 @@ "namespace" ], "type": "object" + }, + "EdFi_GradebookEntry_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradebookEntry_TrackedChangeKey": { + "properties": { + "gradebookEntryIdentifier": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "gradebookEntryIdentifier", + "namespace" + ], + "type": "object" + }, + "EdFi_GradebookEntry_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -139197,7 +172608,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139240,7 +172651,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139262,6 +172673,128 @@ "Gradebook" ] }, + "/ed-fi/gradebookEntries/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "gradebookEntries" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/gradebookEntries/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntry_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "gradebookEntries" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, "/ed-fi/gradebookEntries/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -139297,7 +172830,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139329,15 +172862,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -139364,7 +172888,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139421,7 +172945,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139717,6 +173241,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradebookEntryTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradebookEntryTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -139833,7 +173418,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -139876,7 +173461,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139898,6 +173483,128 @@ "Gradebook" ] }, + "/ed-fi/gradebookEntryTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntryTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "gradebookEntryTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/gradebookEntryTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradebookEntryTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradebookEntryTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "gradebookEntryTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, "/ed-fi/gradebookEntryTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -139933,7 +173640,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -139965,15 +173672,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -140000,7 +173698,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -140057,7 +173755,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -140797,6 +174495,112 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_Grade_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Grade_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "gradeTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "type": "string" + }, + "gradingPeriodSchoolYear": { + "format": "int32", + "type": "integer" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "gradeTypeDescriptor", + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolYear", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_Grade_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -141029,7 +174833,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141072,7 +174876,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141094,6 +174898,128 @@ "ReportCard" ] }, + "/ed-fi/grades/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "grades" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/grades/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Grade_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "grades" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, "/ed-fi/grades/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -141129,7 +175055,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141161,15 +175087,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -141196,7 +175113,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141253,7 +175170,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141565,6 +175482,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GradingPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradingPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GradingPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -141681,7 +175659,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141724,7 +175702,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141747,6 +175725,130 @@ "ReportCard" ] }, + "/ed-fi/gradingPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "gradingPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar", + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/gradingPeriodDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "gradingPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar", + "StudentAcademicRecord", + "ReportCard" + ] + }, "/ed-fi/gradingPeriodDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -141782,7 +175884,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -141814,15 +175916,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -141849,7 +175942,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -141906,7 +175999,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142293,6 +176386,77 @@ "schoolYear" ], "type": "object" + }, + "EdFi_GradingPeriod_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GradingPeriod_TrackedChangeKey": { + "properties": { + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "gradingPeriodDescriptor", + "gradingPeriodName", + "schoolId", + "schoolYear" + ], + "type": "object" + }, + "EdFi_GradingPeriod_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -142429,7 +176593,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142472,7 +176636,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142495,6 +176659,130 @@ "ReportCard" ] }, + "/ed-fi/gradingPeriods/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "gradingPeriods" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar", + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/gradingPeriods/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGradingPeriodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GradingPeriod_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "gradingPeriods" + ] + }, + "x-Ed-Fi-domains": [ + "SchoolCalendar", + "StudentAcademicRecord", + "ReportCard" + ] + }, "/ed-fi/gradingPeriods/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -142530,7 +176818,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142562,15 +176850,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -142597,7 +176876,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -142654,7 +176933,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -142899,6 +177178,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GraduationPlanTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GraduationPlanTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -143015,7 +177355,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143058,7 +177398,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -143080,6 +177420,128 @@ "Graduation" ] }, + "/ed-fi/graduationPlanTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlanTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "graduationPlanTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation" + ] + }, + "/ed-fi/graduationPlanTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlanTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlanTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "graduationPlanTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation" + ] + }, "/ed-fi/graduationPlanTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -143115,7 +177577,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -143147,15 +177609,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -143182,7 +177635,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -143239,7 +177692,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144520,6 +178973,72 @@ "certificationTitle" ], "type": "object" + }, + "EdFi_GraduationPlan_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GraduationPlan_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "graduationPlanTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "graduationSchoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "educationOrganizationId", + "graduationPlanTypeDescriptor", + "graduationSchoolYear" + ], + "type": "object" + }, + "EdFi_GraduationPlan_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -144645,7 +179164,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144688,7 +179207,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144710,6 +179229,128 @@ "Graduation" ] }, + "/ed-fi/graduationPlans/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlansDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "graduationPlans" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation" + ] + }, + "/ed-fi/graduationPlans/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGraduationPlansKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GraduationPlan_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "graduationPlans" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation" + ] + }, "/ed-fi/graduationPlans/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -144745,7 +179386,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -144777,15 +179418,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -144812,7 +179444,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -144869,7 +179501,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145121,6 +179753,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -145237,7 +179930,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145280,7 +179973,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145303,6 +179996,130 @@ "Staff" ] }, + "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getGunFreeSchoolsActReportingStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "gunFreeSchoolsActReportingStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, + "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getGunFreeSchoolsActReportingStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_GunFreeSchoolsActReportingStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "gunFreeSchoolsActReportingStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, "/ed-fi/gunFreeSchoolsActReportingStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -145338,7 +180155,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145370,15 +180187,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -145405,7 +180213,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145462,7 +180270,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145691,6 +180499,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_HireStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_HireStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_HireStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_HireStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_HireStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_HireStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -145807,7 +180676,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -145850,7 +180719,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145871,6 +180740,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/hireStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getHireStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HireStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "hireStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/hireStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getHireStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HireStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "hireStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/hireStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -145906,7 +180895,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -145938,15 +180927,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -145973,7 +180953,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146030,7 +181010,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146257,6 +181237,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_HiringSourceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_HiringSourceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_HiringSourceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_HiringSourceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_HiringSourceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_HiringSourceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -146373,7 +181414,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146416,7 +181457,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146437,6 +181478,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/hiringSourceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getHiringSourcesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HiringSourceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "hiringSourceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/hiringSourceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getHiringSourcesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HiringSourceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "hiringSourceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/hiringSourceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -146472,7 +181633,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146504,15 +181665,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -146539,7 +181691,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146596,7 +181748,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -146823,6 +181975,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -146939,7 +182152,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -146982,7 +182195,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147003,6 +182216,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessPrimaryNighttimeResidencesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "homelessPrimaryNighttimeResidenceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessPrimaryNighttimeResidencesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HomelessPrimaryNighttimeResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "homelessPrimaryNighttimeResidenceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/homelessPrimaryNighttimeResidenceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -147038,7 +182371,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147070,15 +182403,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -147105,7 +182429,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147162,7 +182486,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147389,6 +182713,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_HomelessProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_HomelessProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -147505,7 +182890,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147548,7 +182933,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147569,6 +182954,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/homelessProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "homelessProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/homelessProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getHomelessProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_HomelessProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "homelessProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/homelessProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -147604,7 +183109,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147636,15 +183141,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -147671,7 +183167,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -147728,7 +183224,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -147955,6 +183451,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IdeaEventTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IdeaEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IdeaEventTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IdeaEventTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IdeaEventTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IdeaEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -148071,7 +183628,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148114,7 +183671,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148135,6 +183692,126 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/ideaEventTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIDEAEventTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdeaEventTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "ideaEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, + "/ed-fi/ideaEventTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIDEAEventTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdeaEventTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "ideaEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, "/ed-fi/ideaEventTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -148170,7 +183847,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148202,15 +183879,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -148237,7 +183905,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148294,7 +183962,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148692,6 +184360,77 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_IdeaEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IdeaEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IdeaEvent_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "ideaEventIdentifier": { + "maxLength": 120, + "type": "string" + }, + "ideaEventTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "ideaEventIdentifier", + "ideaEventTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_IdeaEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IdeaEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IdeaEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -148837,7 +184576,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -148880,7 +184619,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148901,6 +184640,126 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/ideaEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIDEAEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdeaEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "ideaEvents" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, + "/ed-fi/ideaEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIDEAEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdeaEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "ideaEvents" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, "/ed-fi/ideaEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -148936,7 +184795,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -148968,15 +184827,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -149003,7 +184853,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149060,7 +184910,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149309,6 +185159,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IdeaPartDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IdeaPartDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IdeaPartDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -149425,7 +185336,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149468,7 +185379,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149489,6 +185400,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/ideaPartDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIDEAPartsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "ideaPartDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/ideaPartDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIDEAPartsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdeaPartDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "ideaPartDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/ideaPartDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -149524,7 +185555,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149556,15 +185587,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -149591,7 +185613,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -149648,7 +185670,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -149899,6 +185921,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IdentificationDocumentUseDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -150015,7 +186098,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150058,7 +186141,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150103,6 +186186,174 @@ "StudentTranscript" ] }, + "/ed-fi/identificationDocumentUseDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIdentificationDocumentUsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "identificationDocumentUseDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "AssessmentRegistration", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/identificationDocumentUseDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIdentificationDocumentUsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IdentificationDocumentUseDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "identificationDocumentUseDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "AssessmentRegistration", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/identificationDocumentUseDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -150138,7 +186389,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150170,15 +186421,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -150205,7 +186447,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150262,7 +186504,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150513,6 +186755,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IepGoalTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IepGoalTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IepGoalTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IepGoalTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IepGoalTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IepGoalTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -150629,7 +186932,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150672,7 +186975,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150693,6 +186996,126 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/iepGoalTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIEPGoalTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IepGoalTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "iepGoalTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, + "/ed-fi/iepGoalTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIEPGoalTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IepGoalTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "iepGoalTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, "/ed-fi/iepGoalTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -150728,7 +187151,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -150760,15 +187183,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -150795,7 +187209,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -150852,7 +187266,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151079,6 +187493,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IepStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IepStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IepStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IepStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IepStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IepStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -151195,7 +187670,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151238,7 +187713,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151259,6 +187734,126 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/iepStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIEPStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IepStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "iepStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, + "/ed-fi/iepStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIEPStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IepStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "iepStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, "/ed-fi/iepStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -151294,7 +187889,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151326,15 +187921,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -151361,7 +187947,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151418,7 +188004,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151645,6 +188231,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ImmunizationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ImmunizationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ImmunizationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -151761,7 +188408,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151804,7 +188451,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151825,6 +188472,126 @@ "StudentHealth" ] }, + "/ed-fi/immunizationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getImmunizationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "immunizationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentHealth" + ] + }, + "/ed-fi/immunizationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getImmunizationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ImmunizationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "immunizationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentHealth" + ] + }, "/ed-fi/immunizationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -151860,7 +188627,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -151892,15 +188659,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -151927,7 +188685,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -151984,7 +188742,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152211,6 +188969,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IncidentLocationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IncidentLocationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IncidentLocationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -152327,7 +189146,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152370,7 +189189,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152391,6 +189210,126 @@ "Discipline" ] }, + "/ed-fi/incidentLocationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIncidentLocationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "incidentLocationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/incidentLocationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIncidentLocationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IncidentLocationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "incidentLocationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/incidentLocationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -152426,7 +189365,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152458,15 +189397,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -152493,7 +189423,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152550,7 +189480,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152795,6 +189725,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IndicatorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IndicatorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IndicatorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -152911,7 +189902,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -152954,7 +189945,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -152993,6 +189984,162 @@ "StudentTranscript" ] }, + "/ed-fi/indicatorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "indicatorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/indicatorDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "indicatorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/indicatorDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -153028,7 +190175,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153060,15 +190207,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -153095,7 +190233,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153152,7 +190290,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153415,6 +190553,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IndicatorGroupDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IndicatorGroupDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IndicatorGroupDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -153531,7 +190730,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153574,7 +190773,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153613,6 +190812,162 @@ "StudentTranscript" ] }, + "/ed-fi/indicatorGroupDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorGroupsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "indicatorGroupDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/indicatorGroupDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorGroupsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorGroupDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "indicatorGroupDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/indicatorGroupDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -153648,7 +191003,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -153680,15 +191035,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -153715,7 +191061,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -153772,7 +191118,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154035,6 +191381,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_IndicatorLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_IndicatorLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_IndicatorLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -154151,7 +191558,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154194,7 +191601,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154233,6 +191640,162 @@ "StudentTranscript" ] }, + "/ed-fi/indicatorLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "indicatorLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/indicatorLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getIndicatorLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_IndicatorLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "indicatorLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/indicatorLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -154268,7 +191831,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154300,15 +191863,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -154335,7 +191889,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154392,7 +191946,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154655,6 +192209,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -154771,7 +192386,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -154814,7 +192429,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154853,6 +192468,162 @@ "StudentTranscript" ] }, + "/ed-fi/institutionTelephoneNumberTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInstitutionTelephoneNumberTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "institutionTelephoneNumberTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/institutionTelephoneNumberTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInstitutionTelephoneNumberTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InstitutionTelephoneNumberTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "institutionTelephoneNumberTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/institutionTelephoneNumberTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -154888,7 +192659,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -154920,15 +192691,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -154955,7 +192717,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155012,7 +192774,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -155257,6 +193019,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InstructionalSettingDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InstructionalSettingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InstructionalSettingDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InstructionalSettingDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InstructionalSettingDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InstructionalSettingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -155373,7 +193196,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155416,7 +193239,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -155437,6 +193260,126 @@ "Credential" ] }, + "/ed-fi/instructionalSettingDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInstructionalSettingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InstructionalSettingDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "instructionalSettingDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, + "/ed-fi/instructionalSettingDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInstructionalSettingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InstructionalSettingDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "instructionalSettingDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential" + ] + }, "/ed-fi/instructionalSettingDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -155472,7 +193415,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -155504,15 +193447,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -155539,7 +193473,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155596,7 +193530,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -155822,6 +193756,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InteractivityStyleDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InteractivityStyleDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InteractivityStyleDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -155938,7 +193933,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -155981,7 +193976,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156001,6 +193996,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/interactivityStyleDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInteractivityStylesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "interactivityStyleDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/interactivityStyleDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInteractivityStylesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InteractivityStyleDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "interactivityStyleDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/interactivityStyleDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -156036,7 +194149,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156068,15 +194181,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -156103,7 +194207,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156160,7 +194264,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156399,6 +194503,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InternetAccessDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InternetAccessDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InternetAccessDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -156515,7 +194680,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156558,7 +194723,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156592,6 +194757,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/internetAccessDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "internetAccessDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/internetAccessDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "internetAccessDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/internetAccessDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -156627,7 +194938,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156659,15 +194970,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -156694,7 +194996,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -156751,7 +195053,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -156992,6 +195294,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -157108,7 +195471,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157151,7 +195514,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157173,6 +195536,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/internetAccessTypeInResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessTypeInResidencesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "internetAccessTypeInResidenceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/internetAccessTypeInResidenceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInternetAccessTypeInResidencesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetAccessTypeInResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "internetAccessTypeInResidenceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/internetAccessTypeInResidenceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -157208,7 +195693,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157240,15 +195725,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -157275,7 +195751,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157332,7 +195808,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157561,6 +196037,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -157677,7 +196214,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157720,7 +196257,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157742,6 +196279,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/internetPerformanceInResidenceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInternetPerformanceInResidencesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "internetPerformanceInResidenceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/internetPerformanceInResidenceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInternetPerformanceInResidencesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InternetPerformanceInResidenceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "internetPerformanceInResidenceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/internetPerformanceInResidenceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -157777,7 +196436,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -157809,15 +196468,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -157844,7 +196494,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -157901,7 +196551,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158130,6 +196780,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InterventionClassDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionClassDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InterventionClassDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -158246,7 +196957,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158289,7 +197000,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158311,6 +197022,128 @@ "StudentCohort" ] }, + "/ed-fi/interventionClassDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionClassesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "interventionClassDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/interventionClassDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionClassesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionClassDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "interventionClassDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/interventionClassDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -158346,7 +197179,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158378,15 +197211,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -158413,7 +197237,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158470,7 +197294,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158699,6 +197523,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -158815,7 +197700,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -158858,7 +197743,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158880,6 +197765,128 @@ "StudentCohort" ] }, + "/ed-fi/interventionEffectivenessRatingDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionEffectivenessRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "interventionEffectivenessRatingDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/interventionEffectivenessRatingDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionEffectivenessRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionEffectivenessRatingDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "interventionEffectivenessRatingDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/interventionEffectivenessRatingDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -158915,7 +197922,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -158947,15 +197954,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -158982,7 +197980,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159039,7 +198037,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159753,6 +198751,67 @@ "interventionPrescriptionIdentificationCode" ], "type": "object" + }, + "EdFi_InterventionPrescription_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionPrescription_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionPrescriptionIdentificationCode": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionPrescriptionIdentificationCode" + ], + "type": "object" + }, + "EdFi_InterventionPrescription_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -159879,7 +198938,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -159922,7 +198981,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -159943,6 +199002,126 @@ "Intervention" ] }, + "/ed-fi/interventionPrescriptions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionPrescriptionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "interventionPrescriptions" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/interventionPrescriptions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionPrescriptionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionPrescription_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "interventionPrescriptions" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, "/ed-fi/interventionPrescriptions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -159978,7 +199157,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -160010,15 +199189,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -160045,7 +199215,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -160102,7 +199272,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -160972,6 +200142,67 @@ "stateAbbreviationDescriptor" ], "type": "object" + }, + "EdFi_InterventionStudy_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_InterventionStudy_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionStudyIdentificationCode": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionStudyIdentificationCode" + ], + "type": "object" + }, + "EdFi_InterventionStudy_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -161099,7 +200330,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -161142,7 +200373,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -161163,6 +200394,126 @@ "Intervention" ] }, + "/ed-fi/interventionStudies/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionStudiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "interventionStudies" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/interventionStudies/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionStudiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_InterventionStudy_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "interventionStudies" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, "/ed-fi/interventionStudies/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -161198,7 +200549,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -161230,15 +200581,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -161265,7 +200607,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -161322,7 +200664,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162299,6 +201641,67 @@ "staffReference" ], "type": "object" + }, + "EdFi_Intervention_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Intervention_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionIdentificationCode": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionIdentificationCode" + ], + "type": "object" + }, + "EdFi_Intervention_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -162443,7 +201846,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162486,7 +201889,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162508,6 +201911,128 @@ "StudentCohort" ] }, + "/ed-fi/interventions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "interventions" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/interventions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getInterventionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Intervention_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "interventions" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/interventions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -162543,7 +202068,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162575,15 +202100,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -162610,7 +202126,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -162667,7 +202183,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -162940,6 +202456,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LanguageDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LanguageDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LanguageDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -163056,7 +202633,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163099,7 +202676,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163139,6 +202716,164 @@ "StudentAssessment" ] }, + "/ed-fi/languageDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLanguagesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "languageDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "AssessmentRegistration", + "BellSchedule", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment" + ] + }, + "/ed-fi/languageDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLanguagesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "languageDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "AssessmentRegistration", + "BellSchedule", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment" + ] + }, "/ed-fi/languageDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -163174,7 +202909,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163206,15 +202941,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -163241,7 +202967,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163298,7 +203024,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163544,6 +203270,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -163660,7 +203447,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163703,7 +203490,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163724,6 +203511,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/languageInstructionProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageInstructionProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "languageInstructionProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/languageInstructionProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageInstructionProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageInstructionProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "languageInstructionProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/languageInstructionProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -163759,7 +203666,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -163791,15 +203698,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -163826,7 +203724,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -163883,7 +203781,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164116,6 +204014,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LanguageUseDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LanguageUseDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LanguageUseDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -164232,7 +204191,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164275,7 +204234,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164302,6 +204261,138 @@ "Survey" ] }, + "/ed-fi/languageUseDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageUsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "languageUseDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "Staff", + "StudentIdentificationAndDemographics", + "Survey" + ] + }, + "/ed-fi/languageUseDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLanguageUsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LanguageUseDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "languageUseDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "Staff", + "StudentIdentificationAndDemographics", + "Survey" + ] + }, "/ed-fi/languageUseDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -164337,7 +204428,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164369,15 +204460,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -164404,7 +204486,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164461,7 +204543,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164700,6 +204782,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LearningStandardCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LearningStandardCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -164816,7 +204959,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -164859,7 +205002,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164886,6 +205029,138 @@ "Standards" ] }, + "/ed-fi/learningStandardCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "learningStandardCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, + "/ed-fi/learningStandardCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "learningStandardCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, "/ed-fi/learningStandardCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -164921,7 +205196,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -164953,15 +205228,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -164988,7 +205254,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165045,7 +205311,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165380,6 +205646,73 @@ "targetLearningStandardId" ], "type": "object" + }, + "EdFi_LearningStandardEquivalenceAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "sourceLearningStandardId": { + "maxLength": 60, + "type": "string" + }, + "targetLearningStandardId": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "namespace", + "sourceLearningStandardId", + "targetLearningStandardId" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -165498,7 +205831,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165541,7 +205874,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165562,6 +205895,126 @@ "Assessment" ] }, + "/ed-fi/learningStandardEquivalenceAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "learningStandardEquivalenceAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, + "/ed-fi/learningStandardEquivalenceAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "learningStandardEquivalenceAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, "/ed-fi/learningStandardEquivalenceAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -165597,7 +206050,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165629,15 +206082,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -165664,7 +206108,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -165721,7 +206165,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -165954,6 +206398,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -166070,7 +206575,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166113,7 +206618,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166134,6 +206639,126 @@ "Assessment" ] }, + "/ed-fi/learningStandardEquivalenceStrengthDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceStrengthsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "learningStandardEquivalenceStrengthDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, + "/ed-fi/learningStandardEquivalenceStrengthDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardEquivalenceStrengthsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardEquivalenceStrengthDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "learningStandardEquivalenceStrengthDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, "/ed-fi/learningStandardEquivalenceStrengthDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -166169,7 +206794,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166201,15 +206826,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -166236,7 +206852,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166293,7 +206909,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166526,6 +207142,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LearningStandardScopeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandardScopeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LearningStandardScopeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -166642,7 +207319,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166685,7 +207362,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166712,6 +207389,138 @@ "Standards" ] }, + "/ed-fi/learningStandardScopeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardScopesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "learningStandardScopeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, + "/ed-fi/learningStandardScopeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardScopesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandardScopeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "learningStandardScopeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, "/ed-fi/learningStandardScopeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -166747,7 +207556,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -166779,15 +207588,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -166814,7 +207614,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -166871,7 +207671,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -167700,6 +208500,62 @@ "learningStandardId" ], "type": "object" + }, + "EdFi_LearningStandard_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LearningStandard_TrackedChangeKey": { + "properties": { + "learningStandardId": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "learningStandardId" + ], + "type": "object" + }, + "EdFi_LearningStandard_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -167854,7 +208710,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -167897,7 +208753,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -167924,6 +208780,138 @@ "Standards" ] }, + "/ed-fi/learningStandards/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "learningStandards" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, + "/ed-fi/learningStandards/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLearningStandardsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LearningStandard_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "learningStandards" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, "/ed-fi/learningStandards/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -167959,7 +208947,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -167991,15 +208979,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -168026,7 +209005,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -168083,7 +209062,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -168347,6 +209326,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LengthOfContractDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LengthOfContractDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LengthOfContractDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LengthOfContractDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LengthOfContractDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LengthOfContractDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -168463,7 +209503,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -168506,7 +209546,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -168527,6 +209567,126 @@ "Staff" ] }, + "/ed-fi/lengthOfContractDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLengthOfContractsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LengthOfContractDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "lengthOfContractDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/lengthOfContractDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLengthOfContractsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LengthOfContractDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "lengthOfContractDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/lengthOfContractDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -168562,7 +209722,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -168594,15 +209754,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -168629,7 +209780,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -168686,7 +209837,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -168925,6 +210076,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LevelOfEducationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LevelOfEducationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LevelOfEducationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -169041,7 +210253,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169084,7 +210296,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169117,6 +210329,150 @@ "SectionsAndPrograms" ] }, + "/ed-fi/levelOfEducationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLevelOfEducationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "levelOfEducationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Intervention", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/levelOfEducationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLevelOfEducationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LevelOfEducationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "levelOfEducationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Intervention", + "RecruitingAndStaffing", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/levelOfEducationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -169152,7 +210508,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169184,15 +210540,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -169219,7 +210566,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169276,7 +210623,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169515,6 +210862,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LicenseStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LicenseStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LicenseStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -169631,7 +211039,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169674,7 +211082,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169695,6 +211103,126 @@ "EducationOrganization" ] }, + "/ed-fi/licenseStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "licenseStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/licenseStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LicenseStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "licenseStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/licenseStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -169730,7 +211258,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -169762,15 +211290,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -169797,7 +211316,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -169854,7 +211373,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -170081,6 +211600,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LicenseTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LicenseTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LicenseTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -170197,7 +211777,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170240,7 +211820,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -170261,6 +211841,126 @@ "EducationOrganization" ] }, + "/ed-fi/licenseTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "licenseTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/licenseTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLicenseTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LicenseTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "licenseTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/licenseTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -170296,7 +211996,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -170328,15 +212028,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -170363,7 +212054,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170420,7 +212111,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -170650,6 +212341,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -170766,7 +212518,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170809,7 +212561,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -170833,6 +212585,132 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/limitedEnglishProficiencyDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLimitedEnglishProficienciesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "limitedEnglishProficiencyDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/limitedEnglishProficiencyDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLimitedEnglishProficienciesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LimitedEnglishProficiencyDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "limitedEnglishProficiencyDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/limitedEnglishProficiencyDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -170868,7 +212746,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -170900,15 +212778,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -170935,7 +212804,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -170992,7 +212861,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -171410,6 +213279,72 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_LocalAccount_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalAccount_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalAccount_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -171529,7 +213464,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -171572,7 +213507,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -171593,6 +213528,126 @@ "Finance" ] }, + "/ed-fi/localAccounts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalAccountsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localAccounts" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localAccounts/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalAccountsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalAccount_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localAccounts" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/localAccounts/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -171628,7 +213683,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -171660,15 +213715,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -171695,7 +213741,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -171752,7 +213798,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172073,6 +214119,77 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_LocalActual_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalActual_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalActual_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -172191,7 +214308,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172234,7 +214351,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172255,6 +214372,126 @@ "Finance" ] }, + "/ed-fi/localActuals/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalActualsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localActuals" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localActuals/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalActualsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalActual_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localActuals" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/localActuals/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -172290,7 +214527,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172322,15 +214559,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -172357,7 +214585,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172414,7 +214642,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172730,6 +214958,77 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_LocalBudget_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalBudget_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalBudget_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -172848,7 +215147,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -172891,7 +215190,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172912,6 +215211,126 @@ "Finance" ] }, + "/ed-fi/localBudgets/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalBudgetsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localBudgets" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localBudgets/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalBudgetsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalBudget_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localBudgets" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/localBudgets/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -172947,7 +215366,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -172979,15 +215398,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -173014,7 +215424,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173071,7 +215481,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173431,6 +215841,82 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_LocalContractedStaff_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalContractedStaff_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_LocalContractedStaff_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -173559,7 +216045,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173602,7 +216088,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173623,6 +216109,126 @@ "Finance" ] }, + "/ed-fi/localContractedStaffs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalContractedStaffsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localContractedStaffs" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localContractedStaffs/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalContractedStaffsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalContractedStaff_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localContractedStaffs" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/localContractedStaffs/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -173658,7 +216264,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -173690,15 +216296,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -173725,7 +216322,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -173782,7 +216379,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -175553,6 +218150,62 @@ "localEducationAgencyId" ], "type": "object" + }, + "EdFi_LocalEducationAgency_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalEducationAgency_TrackedChangeKey": { + "properties": { + "localEducationAgencyId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "localEducationAgencyId" + ], + "type": "object" + }, + "EdFi_LocalEducationAgency_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -175717,7 +218370,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175760,7 +218413,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -175783,6 +218436,130 @@ "Staff" ] }, + "/ed-fi/localEducationAgencies/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgenciesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localEducationAgencies" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, + "/ed-fi/localEducationAgencies/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgenciesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgency_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localEducationAgencies" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, "/ed-fi/localEducationAgencies/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -175818,7 +218595,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -175850,15 +218627,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -175885,7 +218653,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -175942,7 +218710,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176219,6 +218987,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -176335,7 +219164,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176378,7 +219207,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176401,6 +219230,130 @@ "Staff" ] }, + "/ed-fi/localEducationAgencyCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgencyCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localEducationAgencyCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, + "/ed-fi/localEducationAgencyCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEducationAgencyCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEducationAgencyCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localEducationAgencyCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, "/ed-fi/localEducationAgencyCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -176436,7 +219389,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176468,15 +219421,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -176503,7 +219447,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -176560,7 +219504,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -176875,6 +219819,77 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_LocalEncumbrance_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalEncumbrance_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_LocalEncumbrance_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -176993,7 +220008,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177036,7 +220051,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177057,6 +220072,126 @@ "Finance" ] }, + "/ed-fi/localEncumbrances/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEncumbrancesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localEncumbrances" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localEncumbrances/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalEncumbrancesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalEncumbrance_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localEncumbrances" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/localEncumbrances/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -177092,7 +220227,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177124,15 +220259,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -177159,7 +220285,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177216,7 +220342,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177576,6 +220702,82 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_LocalPayroll_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocalPayroll_TrackedChangeKey": { + "properties": { + "accountIdentifier": { + "maxLength": 50, + "type": "string" + }, + "asOfDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "accountIdentifier", + "asOfDate", + "educationOrganizationId", + "fiscalYear", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_LocalPayroll_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -177704,7 +220906,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177747,7 +220949,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177768,6 +220970,126 @@ "Finance" ] }, + "/ed-fi/localPayrolls/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalPayrollsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localPayrolls" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/localPayrolls/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalPayrollsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocalPayroll_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localPayrolls" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/localPayrolls/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -177803,7 +221125,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -177835,15 +221157,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -177870,7 +221183,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -177927,7 +221240,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178185,6 +221498,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_LocaleDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_LocaleDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_LocaleDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -178301,7 +221675,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178344,7 +221718,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178386,6 +221760,168 @@ "StudentTranscript" ] }, + "/ed-fi/localeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocalesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "localeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/localeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocalesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_LocaleDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "localeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/localeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -178421,7 +221957,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178453,15 +221989,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -178488,7 +222015,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178545,7 +222072,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178829,6 +222356,67 @@ "schoolId" ], "type": "object" + }, + "EdFi_Location_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Location_TrackedChangeKey": { + "properties": { + "classroomIdentificationCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "classroomIdentificationCode", + "schoolId" + ], + "type": "object" + }, + "EdFi_Location_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -178927,7 +222515,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -178970,7 +222558,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -178992,6 +222580,128 @@ "SectionsAndPrograms" ] }, + "/ed-fi/locations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getLocationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "locations" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/locations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getLocationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Location_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "locations" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/locations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -179027,7 +222737,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179059,15 +222769,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -179094,7 +222795,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179151,7 +222852,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179384,6 +223085,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -179500,7 +223262,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179543,7 +223305,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179577,6 +223339,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMagnetSpecialProgramEmphasisSchoolsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "magnetSpecialProgramEmphasisSchoolDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMagnetSpecialProgramEmphasisSchoolsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MagnetSpecialProgramEmphasisSchoolDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "magnetSpecialProgramEmphasisSchoolDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/magnetSpecialProgramEmphasisSchoolDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -179612,7 +223520,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179644,15 +223552,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -179679,7 +223578,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -179736,7 +223635,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -179990,6 +223889,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MediumOfInstructionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MediumOfInstructionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MediumOfInstructionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -180106,7 +224066,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180149,7 +224109,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180184,6 +224144,154 @@ "SectionsAndPrograms" ] }, + "/ed-fi/mediumOfInstructionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMediumOfInstructionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "mediumOfInstructionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "EducationOrganization", + "Graduation", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/mediumOfInstructionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMediumOfInstructionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MediumOfInstructionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "mediumOfInstructionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "EducationOrganization", + "Graduation", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/mediumOfInstructionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -180219,7 +224327,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180251,15 +224359,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -180286,7 +224385,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180343,7 +224442,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180587,6 +224686,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MethodCreditEarnedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MethodCreditEarnedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -180703,7 +224863,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180746,7 +224906,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180770,6 +224930,132 @@ "StudentTranscript" ] }, + "/ed-fi/methodCreditEarnedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMethodCreditEarnedsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "methodCreditEarnedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/methodCreditEarnedDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMethodCreditEarnedsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MethodCreditEarnedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "methodCreditEarnedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/methodCreditEarnedDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -180805,7 +225091,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -180837,15 +225123,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -180872,7 +225149,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -180929,7 +225206,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181159,6 +225436,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -181275,7 +225613,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181318,7 +225656,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181339,6 +225677,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/migrantEducationProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMigrantEducationProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "migrantEducationProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/migrantEducationProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMigrantEducationProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MigrantEducationProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "migrantEducationProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/migrantEducationProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -181374,7 +225832,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181406,15 +225864,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -181441,7 +225890,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181498,7 +225947,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181725,6 +226174,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ModelEntityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ModelEntityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ModelEntityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -181841,7 +226351,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -181884,7 +226394,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181905,6 +226415,126 @@ "EducationOrganization" ] }, + "/ed-fi/modelEntityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getModelEntitiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "modelEntityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/modelEntityDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getModelEntitiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ModelEntityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "modelEntityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/modelEntityDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -181940,7 +226570,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -181972,15 +226602,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -182007,7 +226628,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182064,7 +226685,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -182291,6 +226912,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_MonitoredDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_MonitoredDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_MonitoredDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -182407,7 +227089,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182450,7 +227132,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -182471,6 +227153,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/monitoredDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getMonitoredsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "monitoredDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/monitoredDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getMonitoredsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_MonitoredDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "monitoredDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/monitoredDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -182506,7 +227308,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -182538,15 +227340,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -182573,7 +227366,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -182630,7 +227423,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -182857,6 +227650,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -182973,7 +227827,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183016,7 +227870,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183037,6 +227891,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/neglectedOrDelinquentProgramDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "neglectedOrDelinquentProgramDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/neglectedOrDelinquentProgramDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "neglectedOrDelinquentProgramDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/neglectedOrDelinquentProgramDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -183072,7 +228046,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183104,15 +228078,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -183139,7 +228104,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183196,7 +228161,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183423,6 +228388,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -183539,7 +228565,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183582,7 +228608,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183603,6 +228629,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "neglectedOrDelinquentProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNeglectedOrDelinquentProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NeglectedOrDelinquentProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "neglectedOrDelinquentProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/neglectedOrDelinquentProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -183638,7 +228784,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183670,15 +228816,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -183705,7 +228842,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -183762,7 +228899,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -183989,6 +229126,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NetworkPurposeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NetworkPurposeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NetworkPurposeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -184105,7 +229303,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184148,7 +229346,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -184169,6 +229367,126 @@ "EducationOrganization" ] }, + "/ed-fi/networkPurposeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNetworkPurposesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "networkPurposeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/networkPurposeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNetworkPurposesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NetworkPurposeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "networkPurposeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/networkPurposeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -184204,7 +229522,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -184236,15 +229554,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -184271,7 +229580,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184328,7 +229637,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -184555,6 +229864,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -184671,7 +230041,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184714,7 +230084,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -184735,6 +230105,126 @@ "StudentHealth" ] }, + "/ed-fi/nonMedicalImmunizationExemptionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getNonMedicalImmunizationExemptionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "nonMedicalImmunizationExemptionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentHealth" + ] + }, + "/ed-fi/nonMedicalImmunizationExemptionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getNonMedicalImmunizationExemptionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_NonMedicalImmunizationExemptionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "nonMedicalImmunizationExemptionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentHealth" + ] + }, "/ed-fi/nonMedicalImmunizationExemptionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -184770,7 +230260,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -184802,15 +230292,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -184837,7 +230318,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -184894,7 +230375,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -185182,6 +230663,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ObjectDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ObjectDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ObjectDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -185271,7 +230813,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -185314,7 +230856,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -185335,6 +230877,126 @@ "Finance" ] }, + "/ed-fi/objectDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getObjectDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "objectDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/objectDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getObjectDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "objectDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/objectDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -185370,7 +231032,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -185402,15 +231064,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -185437,7 +231090,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -185494,7 +231147,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -186345,6 +231998,73 @@ "identificationCode" ], "type": "object" + }, + "EdFi_ObjectiveAssessment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ObjectiveAssessment_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "identificationCode": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "identificationCode", + "namespace" + ], + "type": "object" + }, + "EdFi_ObjectiveAssessment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -186481,7 +232201,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -186524,7 +232244,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -186546,6 +232266,128 @@ "AssessmentMetadata" ] }, + "/ed-fi/objectiveAssessments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getObjectiveAssessmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "objectiveAssessments" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, + "/ed-fi/objectiveAssessments/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getObjectiveAssessmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectiveAssessment_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "objectiveAssessments" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentMetadata" + ] + }, "/ed-fi/objectiveAssessments/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -186581,7 +232423,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -186613,15 +232455,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -186648,7 +232481,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -186705,7 +232538,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -186955,6 +232788,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ObjectiveRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ObjectiveRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ObjectiveRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ObjectiveRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -187071,7 +232965,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -187114,7 +233008,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -187135,6 +233029,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/objectiveRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getObjectiveRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectiveRatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "objectiveRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/objectiveRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getObjectiveRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ObjectiveRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "objectiveRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/objectiveRatingLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -187170,7 +233184,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -187202,15 +233216,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -187237,7 +233242,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -187294,7 +233299,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -187521,6 +233526,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_OpenStaffPositionEventStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OpenStaffPositionEventStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_OpenStaffPositionEventStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -187637,7 +233703,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -187680,7 +233746,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -187701,6 +233767,126 @@ "Staff" ] }, + "/ed-fi/openStaffPositionEventStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionEventStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "openStaffPositionEventStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/openStaffPositionEventStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionEventStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "openStaffPositionEventStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/openStaffPositionEventStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -187736,7 +233922,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -187768,15 +233954,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -187803,7 +233980,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -187860,7 +234037,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188087,6 +234264,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_OpenStaffPositionEventTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OpenStaffPositionEventTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_OpenStaffPositionEventTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -188203,7 +234441,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188246,7 +234484,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188267,6 +234505,126 @@ "Staff" ] }, + "/ed-fi/openStaffPositionEventTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionEventTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "openStaffPositionEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/openStaffPositionEventTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionEventTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEventTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "openStaffPositionEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/openStaffPositionEventTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -188302,7 +234660,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188334,15 +234692,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -188369,7 +234718,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188426,7 +234775,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188722,6 +235071,77 @@ "openStaffPositionEventTypeDescriptor" ], "type": "object" + }, + "EdFi_OpenStaffPositionEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OpenStaffPositionEvent_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "openStaffPositionEventTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "requisitionNumber": { + "maxLength": 20, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "eventDate", + "openStaffPositionEventTypeDescriptor", + "requisitionNumber" + ], + "type": "object" + }, + "EdFi_OpenStaffPositionEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -188831,7 +235251,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -188874,7 +235294,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188895,6 +235315,126 @@ "Staff" ] }, + "/ed-fi/openStaffPositionEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "openStaffPositionEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/openStaffPositionEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "openStaffPositionEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/openStaffPositionEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -188930,7 +235470,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -188962,15 +235502,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -188997,7 +235528,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -189054,7 +235585,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -189278,6 +235809,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_OpenStaffPositionReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OpenStaffPositionReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_OpenStaffPositionReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -189394,7 +235986,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -189437,7 +236029,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -189458,6 +236050,126 @@ "Staff" ] }, + "/ed-fi/openStaffPositionReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "openStaffPositionReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/openStaffPositionReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPositionReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "openStaffPositionReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/openStaffPositionReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -189493,7 +236205,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -189525,15 +236237,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -189560,7 +236263,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -189617,7 +236320,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -190338,6 +237041,67 @@ "requisitionNumber" ], "type": "object" + }, + "EdFi_OpenStaffPosition_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OpenStaffPosition_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "requisitionNumber": { + "maxLength": 20, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "requisitionNumber" + ], + "type": "object" + }, + "EdFi_OpenStaffPosition_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -190579,7 +237343,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190622,7 +237386,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -190643,6 +237407,126 @@ "Staff" ] }, + "/ed-fi/openStaffPositions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "openStaffPositions" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/openStaffPositions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOpenStaffPositionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OpenStaffPosition_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "openStaffPositions" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/openStaffPositions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -190678,7 +237562,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -190710,15 +237594,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -190745,7 +237620,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -190802,7 +237677,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191134,6 +238009,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_OperationalStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OperationalStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_OperationalStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -191250,7 +238186,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191293,7 +238229,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191332,6 +238268,162 @@ "StudentTranscript" ] }, + "/ed-fi/operationalStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "operationalStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/operationalStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OperationalStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "operationalStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "EducationOrganization", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentCohort", + "StudentHealth", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "ReportCard", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/operationalStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -191367,7 +238459,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191399,15 +238491,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -191434,7 +238517,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191491,7 +238574,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191797,6 +238880,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_OperationalUnitDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OperationalUnitDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_OperationalUnitDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -191886,7 +239030,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -191929,7 +239073,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -191950,6 +239094,126 @@ "Finance" ] }, + "/ed-fi/operationalUnitDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalUnitDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "operationalUnitDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/operationalUnitDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOperationalUnitDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OperationalUnitDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "operationalUnitDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/operationalUnitDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -191985,7 +239249,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -192017,15 +239281,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -192052,7 +239307,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -192109,7 +239364,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -193390,6 +240645,62 @@ "organizationDepartmentId" ], "type": "object" + }, + "EdFi_OrganizationDepartment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OrganizationDepartment_TrackedChangeKey": { + "properties": { + "organizationDepartmentId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "organizationDepartmentId" + ], + "type": "object" + }, + "EdFi_OrganizationDepartment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -193516,7 +240827,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -193559,7 +240870,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -193580,6 +240891,126 @@ "EducationOrganization" ] }, + "/ed-fi/organizationDepartments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOrganizationDepartmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "organizationDepartments" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/organizationDepartments/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOrganizationDepartmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OrganizationDepartment_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "organizationDepartments" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/organizationDepartments/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -193615,7 +241046,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -193647,15 +241078,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -193682,7 +241104,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -193739,7 +241161,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -194008,6 +241430,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_OtherNameTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_OtherNameTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_OtherNameTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -194124,7 +241607,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194167,7 +241650,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -194210,6 +241693,170 @@ "StudentTranscript" ] }, + "/ed-fi/otherNameTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getOtherNameTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "otherNameTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/otherNameTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getOtherNameTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_OtherNameTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "otherNameTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/otherNameTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -194245,7 +241892,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -194277,15 +241924,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -194312,7 +241950,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194369,7 +242007,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -194618,6 +242256,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ParticipationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ParticipationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ParticipationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -194734,7 +242433,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194777,7 +242476,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -194798,6 +242497,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/participationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "participationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/participationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "participationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/participationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -194833,7 +242652,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -194865,15 +242684,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -194900,7 +242710,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -194957,7 +242767,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -195184,6 +242994,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ParticipationStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ParticipationStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ParticipationStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -195300,7 +243171,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -195343,7 +243214,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -195364,6 +243235,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/participationStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "participationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/participationStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getParticipationStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ParticipationStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "participationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/participationStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -195399,7 +243390,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -195431,15 +243422,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -195466,7 +243448,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -195523,7 +243505,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -195750,6 +243732,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PathMilestoneStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestoneStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PathMilestoneStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PathMilestoneStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestoneStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestoneStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -195866,7 +243909,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -195909,7 +243952,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -195930,6 +243973,126 @@ "Path" ] }, + "/ed-fi/pathMilestoneStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPathMilestoneStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathMilestoneStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "pathMilestoneStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/pathMilestoneStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPathMilestoneStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathMilestoneStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "pathMilestoneStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/pathMilestoneStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -195965,7 +244128,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -195997,15 +244160,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -196032,7 +244186,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -196089,7 +244243,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -196316,6 +244470,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PathMilestoneTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestoneTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PathMilestoneTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PathMilestoneTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestoneTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestoneTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -196432,7 +244647,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -196475,7 +244690,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -196496,6 +244711,126 @@ "Path" ] }, + "/ed-fi/pathMilestoneTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPathMilestoneTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathMilestoneTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "pathMilestoneTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/pathMilestoneTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPathMilestoneTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathMilestoneTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "pathMilestoneTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/pathMilestoneTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -196531,7 +244866,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -196563,15 +244898,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -196598,7 +244924,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -196655,7 +244981,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -196907,6 +245233,68 @@ "pathMilestoneTypeDescriptor" ], "type": "object" + }, + "EdFi_PathMilestone_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestone_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PathMilestone_TrackedChangeKey": { + "properties": { + "pathMilestoneName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + }, + "pathMilestoneTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "pathMilestoneName", + "pathMilestoneTypeDescriptor" + ], + "type": "object" + }, + "EdFi_PathMilestone_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestone_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PathMilestone_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -197007,7 +245395,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -197050,7 +245438,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -197071,6 +245459,126 @@ "Path" ] }, + "/ed-fi/pathMilestones/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPathMilestonesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathMilestone_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "pathMilestones" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/pathMilestones/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPathMilestonesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathMilestone_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "pathMilestones" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/pathMilestones/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -197106,7 +245614,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -197138,15 +245646,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -197173,7 +245672,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -197230,7 +245729,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -197444,6 +245943,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PathPhaseStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PathPhaseStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PathPhaseStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PathPhaseStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PathPhaseStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PathPhaseStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -197560,7 +246120,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -197603,7 +246163,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -197624,6 +246184,126 @@ "Path" ] }, + "/ed-fi/pathPhaseStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPathPhaseStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathPhaseStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "pathPhaseStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/pathPhaseStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPathPhaseStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathPhaseStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "pathPhaseStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/pathPhaseStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -197659,7 +246339,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -197691,15 +246371,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -197726,7 +246397,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -197783,7 +246454,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198144,6 +246815,74 @@ "pathPhaseName" ], "type": "object" + }, + "EdFi_PathPhase_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PathPhase_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PathPhase_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "pathName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + }, + "pathPhaseName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "pathName", + "pathPhaseName" + ], + "type": "object" + }, + "EdFi_PathPhase_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PathPhase_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PathPhase_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -198254,7 +246993,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198297,7 +247036,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198318,6 +247057,126 @@ "Path" ] }, + "/ed-fi/pathPhases/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPathPhasesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathPhase_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "pathPhases" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/pathPhases/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPathPhasesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PathPhase_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "pathPhases" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/pathPhases/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -198353,7 +247212,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198385,15 +247244,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -198420,7 +247270,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198477,7 +247327,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198763,6 +247613,68 @@ "pathName" ], "type": "object" + }, + "EdFi_Path_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Path_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Path_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "pathName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "pathName" + ], + "type": "object" + }, + "EdFi_Path_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Path_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Path_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -198864,7 +247776,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -198907,7 +247819,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198928,6 +247840,126 @@ "Path" ] }, + "/ed-fi/paths/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPathsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Path_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "paths" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/paths/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPathsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Path_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "paths" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/paths/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -198963,7 +247995,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -198995,15 +248027,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -199030,7 +248053,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199087,7 +248110,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -199290,6 +248313,67 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "EdFi_Person_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Person_TrackedChangeKey": { + "properties": { + "personId": { + "maxLength": 32, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "personId", + "sourceSystemDescriptor" + ], + "type": "object" + }, + "EdFi_Person_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -199370,7 +248454,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199413,7 +248497,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -199435,6 +248519,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/people/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPeopleDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "people" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/people/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPeopleKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Person_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "people" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/people/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -199470,7 +248676,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -199502,15 +248708,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -199537,7 +248734,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199594,7 +248791,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -199798,6 +248995,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PerformanceBaseConversionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -199914,7 +249172,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -199957,7 +249215,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -199979,6 +249237,128 @@ "ReportCard" ] }, + "/ed-fi/performanceBaseConversionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceBaseConversionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceBaseConversionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/performanceBaseConversionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceBaseConversionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceBaseConversionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "performanceBaseConversionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, "/ed-fi/performanceBaseConversionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -200014,7 +249394,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200046,15 +249426,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -200081,7 +249452,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200138,7 +249509,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200366,6 +249737,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -200482,7 +249914,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200525,7 +249957,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200546,6 +249978,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/performanceEvaluationRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceEvaluationRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceEvaluationRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/performanceEvaluationRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceEvaluationRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "performanceEvaluationRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/performanceEvaluationRatingLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -200581,7 +250133,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -200613,15 +250165,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -200648,7 +250191,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -200705,7 +250248,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -201494,6 +251037,98 @@ "lastSurname" ], "type": "object" + }, + "EdFi_PerformanceEvaluationRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceEvaluationRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationPeriodDescriptor", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_PerformanceEvaluationRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -201706,7 +251341,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -201749,7 +251384,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -201770,6 +251405,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/performanceEvaluationRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceEvaluationRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceEvaluationRatings" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/performanceEvaluationRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceEvaluationRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "performanceEvaluationRatings" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/performanceEvaluationRatings/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -201805,7 +251560,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -201837,15 +251592,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -201872,7 +251618,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -201929,7 +251675,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -202227,6 +251973,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PerformanceEvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceEvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PerformanceEvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -202343,7 +252150,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -202386,7 +252193,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -202407,6 +252214,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/performanceEvaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceEvaluationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceEvaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/performanceEvaluationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceEvaluationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "performanceEvaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/performanceEvaluationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -202442,7 +252369,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -202474,15 +252401,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -202509,7 +252427,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -202566,7 +252484,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -203128,6 +253046,88 @@ "termDescriptor" ], "type": "object" + }, + "EdFi_PerformanceEvaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceEvaluation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationPeriodDescriptor", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_PerformanceEvaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -203267,7 +253267,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -203310,7 +253310,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -203331,6 +253331,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/performanceEvaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceEvaluationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceEvaluations" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/performanceEvaluations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceEvaluationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceEvaluation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "performanceEvaluations" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/performanceEvaluations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -203366,7 +253486,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -203398,15 +253518,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -203433,7 +253544,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -203490,7 +253601,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -203743,6 +253854,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PerformanceLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PerformanceLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PerformanceLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -203859,7 +254031,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -203902,7 +254074,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -203927,6 +254099,134 @@ "StudentAssessment" ] }, + "/ed-fi/performanceLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "Enrollment", + "Graduation", + "AssessmentMetadata", + "StudentAssessment" + ] + }, + "/ed-fi/performanceLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPerformanceLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PerformanceLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "performanceLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "Enrollment", + "Graduation", + "AssessmentMetadata", + "StudentAssessment" + ] + }, "/ed-fi/performanceLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -203962,7 +254262,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -203994,15 +254294,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -204029,7 +254320,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204086,7 +254377,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -204341,6 +254632,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PersonalInformationVerificationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -204457,7 +254809,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204500,7 +254852,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -204545,6 +254897,174 @@ "StudentTranscript" ] }, + "/ed-fi/personalInformationVerificationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPersonalInformationVerificationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "personalInformationVerificationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "AssessmentRegistration", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/personalInformationVerificationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPersonalInformationVerificationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PersonalInformationVerificationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "personalInformationVerificationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "AssessmentRegistration", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/personalInformationVerificationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -204580,7 +255100,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -204612,15 +255132,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -204647,7 +255158,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -204704,7 +255215,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -204958,6 +255469,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PlatformTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PlatformTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PlatformTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -205074,7 +255646,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205117,7 +255689,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -205141,6 +255713,132 @@ "StudentAssessment" ] }, + "/ed-fi/platformTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPlatformTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "platformTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentRegistration", + "AssessmentMetadata", + "StudentAssessment" + ] + }, + "/ed-fi/platformTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPlatformTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PlatformTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "platformTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "AssessmentRegistration", + "AssessmentMetadata", + "StudentAssessment" + ] + }, "/ed-fi/platformTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -205176,7 +255874,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -205208,15 +255906,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -205243,7 +255932,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205300,7 +255989,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -205544,6 +256233,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PopulationServedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PopulationServedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PopulationServedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -205660,7 +256410,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205703,7 +256453,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -205738,6 +256488,154 @@ "SectionsAndPrograms" ] }, + "/ed-fi/populationServedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPopulationServedsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "populationServedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Credential", + "Intervention", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/populationServedDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPopulationServedsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PopulationServedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "populationServedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Credential", + "Intervention", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/populationServedDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -205773,7 +256671,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -205805,15 +256703,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -205840,7 +256729,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -205897,7 +256786,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206138,6 +257027,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -206254,7 +257204,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206297,7 +257247,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206318,6 +257268,126 @@ "Graduation" ] }, + "/ed-fi/postSecondaryEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "postSecondaryEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation" + ] + }, + "/ed-fi/postSecondaryEventCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "postSecondaryEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation" + ] + }, "/ed-fi/postSecondaryEventCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -206353,7 +257423,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206385,15 +257455,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -206420,7 +257481,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206477,7 +257538,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206766,6 +257827,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_PostSecondaryEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryEvent_TrackedChangeKey": { + "properties": { + "eventDate": { + "format": "date", + "type": "string" + }, + "postSecondaryEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "eventDate", + "postSecondaryEventCategoryDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_PostSecondaryEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -206866,7 +257993,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -206909,7 +258036,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206930,6 +258057,126 @@ "Graduation" ] }, + "/ed-fi/postSecondaryEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "postSecondaryEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation" + ] + }, + "/ed-fi/postSecondaryEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "postSecondaryEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation" + ] + }, "/ed-fi/postSecondaryEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -206965,7 +258212,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -206997,15 +258244,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -207032,7 +258270,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207089,7 +258327,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -207305,6 +258543,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -207421,7 +258720,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207464,7 +258763,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -207486,6 +258785,128 @@ "Graduation" ] }, + "/ed-fi/postSecondaryInstitutionLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "postSecondaryInstitutionLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Graduation" + ] + }, + "/ed-fi/postSecondaryInstitutionLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitutionLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "postSecondaryInstitutionLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Graduation" + ] + }, "/ed-fi/postSecondaryInstitutionLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -207521,7 +258942,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -207553,15 +258974,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -207588,7 +259000,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -207645,7 +259057,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209010,6 +260422,62 @@ "postSecondaryInstitutionId" ], "type": "object" + }, + "EdFi_PostSecondaryInstitution_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitution_TrackedChangeKey": { + "properties": { + "postSecondaryInstitutionId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "postSecondaryInstitutionId" + ], + "type": "object" + }, + "EdFi_PostSecondaryInstitution_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -209144,7 +260612,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209187,7 +260655,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209209,6 +260677,128 @@ "Graduation" ] }, + "/ed-fi/postSecondaryInstitutions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "postSecondaryInstitutions" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Graduation" + ] + }, + "/ed-fi/postSecondaryInstitutions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostSecondaryInstitutionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostSecondaryInstitution_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "postSecondaryInstitutions" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Graduation" + ] + }, "/ed-fi/postSecondaryInstitutions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -209244,7 +260834,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209276,15 +260866,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -209311,7 +260892,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209368,7 +260949,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209621,6 +261202,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PostingResultDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PostingResultDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PostingResultDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -209737,7 +261379,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209780,7 +261422,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209801,6 +261443,126 @@ "Staff" ] }, + "/ed-fi/postingResultDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPostingResultsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "postingResultDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/postingResultDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPostingResultsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PostingResultDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "postingResultDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/postingResultDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -209836,7 +261598,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -209868,15 +261630,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -209903,7 +261656,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -209960,7 +261713,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -210187,6 +261940,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PreviousCareerDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PreviousCareerDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PreviousCareerDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PreviousCareerDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PreviousCareerDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PreviousCareerDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -210303,7 +262117,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -210346,7 +262160,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -210367,6 +262181,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/previousCareerDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPreviousCareersDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PreviousCareerDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "previousCareerDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/previousCareerDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPreviousCareersKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PreviousCareerDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "previousCareerDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/previousCareerDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -210402,7 +262336,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -210434,15 +262368,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -210469,7 +262394,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -210526,7 +262451,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -210754,6 +262679,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -210870,7 +262856,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -210913,7 +262899,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -210935,6 +262921,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/primaryLearningDeviceAccessDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAccessesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "primaryLearningDeviceAccessDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/primaryLearningDeviceAccessDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAccessesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAccessDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "primaryLearningDeviceAccessDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/primaryLearningDeviceAccessDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -210970,7 +263078,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -211002,15 +263110,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -211037,7 +263136,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -211094,7 +263193,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -211323,6 +263422,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -211439,7 +263599,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -211482,7 +263642,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -211504,6 +263664,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAwayFromSchoolsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "primaryLearningDeviceAwayFromSchoolDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceAwayFromSchoolsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceAwayFromSchoolDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "primaryLearningDeviceAwayFromSchoolDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/primaryLearningDeviceAwayFromSchoolDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -211539,7 +263821,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -211571,15 +263853,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -211606,7 +263879,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -211663,7 +263936,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -211892,6 +264165,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -212008,7 +264342,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212051,7 +264385,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -212073,6 +264407,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/primaryLearningDeviceProviderDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceProvidersDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "primaryLearningDeviceProviderDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/primaryLearningDeviceProviderDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPrimaryLearningDeviceProvidersKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PrimaryLearningDeviceProviderDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "primaryLearningDeviceProviderDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/primaryLearningDeviceProviderDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -212108,7 +264564,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -212140,15 +264596,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -212175,7 +264622,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212232,7 +264679,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -212584,6 +265031,84 @@ "professionalDevelopmentTitle" ], "type": "object" + }, + "EdFi_ProfessionalDevelopmentEventAttendance_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEventAttendance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProfessionalDevelopmentEventAttendance_TrackedChangeKey": { + "properties": { + "attendanceDate": { + "format": "date", + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "professionalDevelopmentTitle": { + "maxLength": 60, + "minLength": 1, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "attendanceDate", + "namespace", + "personId", + "professionalDevelopmentTitle", + "sourceSystemDescriptor" + ], + "type": "object" + }, + "EdFi_ProfessionalDevelopmentEventAttendance_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEventAttendance_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEventAttendance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -212714,7 +265239,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212757,7 +265282,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -212778,6 +265303,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/professionalDevelopmentEventAttendances/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProfessionalDevelopmentEventAttendancesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEventAttendance_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "professionalDevelopmentEventAttendances" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/professionalDevelopmentEventAttendances/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProfessionalDevelopmentEventAttendancesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEventAttendance_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "professionalDevelopmentEventAttendances" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/professionalDevelopmentEventAttendances/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -212813,7 +265458,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -212845,15 +265490,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -212880,7 +265516,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -212937,7 +265573,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -213253,6 +265889,69 @@ "professionalDevelopmentTitle" ], "type": "object" + }, + "EdFi_ProfessionalDevelopmentEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProfessionalDevelopmentEvent_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "professionalDevelopmentTitle": { + "maxLength": 60, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "namespace", + "professionalDevelopmentTitle" + ], + "type": "object" + }, + "EdFi_ProfessionalDevelopmentEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -213379,7 +266078,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -213422,7 +266121,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -213443,6 +266142,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/professionalDevelopmentEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProfessionalDevelopmentEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "professionalDevelopmentEvents" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/professionalDevelopmentEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProfessionalDevelopmentEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "professionalDevelopmentEvents" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/professionalDevelopmentEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -213478,7 +266297,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -213510,15 +266329,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -213545,7 +266355,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -213602,7 +266412,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -213835,6 +266645,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProfessionalDevelopmentOfferedByDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentOfferedByDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProfessionalDevelopmentOfferedByDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProfessionalDevelopmentOfferedByDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentOfferedByDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentOfferedByDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -213951,7 +266822,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -213994,7 +266865,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214015,6 +266886,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/professionalDevelopmentOfferedByDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProfessionalDevelopmentOfferedBiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentOfferedByDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "professionalDevelopmentOfferedByDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/professionalDevelopmentOfferedByDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProfessionalDevelopmentOfferedBiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProfessionalDevelopmentOfferedByDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "professionalDevelopmentOfferedByDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/professionalDevelopmentOfferedByDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -214050,7 +267041,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214082,15 +267073,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -214117,7 +267099,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214174,7 +267156,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214401,6 +267383,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProficiencyDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProficiencyDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProficiencyDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -214517,7 +267560,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214560,7 +267603,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214581,6 +267624,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/proficiencyDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProficienciesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "proficiencyDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/proficiencyDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProficienciesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProficiencyDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "proficiencyDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/proficiencyDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -214616,7 +267779,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214648,15 +267811,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -214683,7 +267837,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -214740,7 +267894,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -214969,6 +268123,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramAssignmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramAssignmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramAssignmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -215085,7 +268300,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215128,7 +268343,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -215151,6 +268366,130 @@ "SectionsAndPrograms" ] }, + "/ed-fi/programAssignmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramAssignmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programAssignmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/programAssignmentDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramAssignmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramAssignmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programAssignmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/programAssignmentDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -215186,7 +268525,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -215218,15 +268557,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -215253,7 +268583,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215310,7 +268640,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -215550,6 +268880,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -215666,7 +269057,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215709,7 +269100,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -215741,6 +269132,148 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramCharacteristicsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programCharacteristicDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramCharacteristicsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programCharacteristicDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -215776,7 +269309,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -215808,15 +269341,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -215843,7 +269367,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -215900,7 +269424,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -216199,6 +269723,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ProgramDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ProgramDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -216288,7 +269873,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -216331,7 +269916,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -216352,6 +269937,126 @@ "Finance" ] }, + "/ed-fi/programDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/programDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/programDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -216387,7 +270092,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -216419,15 +270124,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -216454,7 +270150,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -216511,7 +270207,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -217125,6 +270821,92 @@ "programEvaluationElementTitle" ], "type": "object" + }, + "EdFi_ProgramEvaluationElement_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationElement_TrackedChangeKey": { + "properties": { + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationElementTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "programEducationOrganizationId", + "programEvaluationElementTitle", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationElement_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -217301,7 +271083,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217344,7 +271126,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -217366,6 +271148,128 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programEvaluationElements/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationElementsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programEvaluationElements" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationElements/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationElementsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationElement_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programEvaluationElements" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programEvaluationElements/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -217401,7 +271305,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -217433,15 +271337,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -217468,7 +271363,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -217525,7 +271420,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -218078,6 +271973,92 @@ "programEvaluationObjectiveTitle" ], "type": "object" + }, + "EdFi_ProgramEvaluationObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationObjective_TrackedChangeKey": { + "properties": { + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationObjectiveTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "programEducationOrganizationId", + "programEvaluationObjectiveTitle", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -218244,7 +272225,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218287,7 +272268,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -218309,6 +272290,128 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programEvaluationObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationObjectivesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programEvaluationObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationObjectives/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationObjectivesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationObjective_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programEvaluationObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programEvaluationObjectives/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -218344,7 +272447,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -218376,15 +272479,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -218411,7 +272505,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218468,7 +272562,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -218737,6 +272831,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -218853,7 +273008,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -218896,7 +273051,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -218918,6 +273073,128 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programEvaluationPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationPeriodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programEvaluationPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationPeriodDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationPeriodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programEvaluationPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programEvaluationPeriodDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -218953,7 +273230,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -218985,15 +273262,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -219020,7 +273288,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219077,7 +273345,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -219306,6 +273574,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -219422,7 +273751,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219465,7 +273794,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -219487,6 +273816,128 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programEvaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programEvaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programEvaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programEvaluationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -219522,7 +273973,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -219554,15 +274005,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -219589,7 +274031,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -219646,7 +274088,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -220138,6 +274580,87 @@ "programEvaluationTypeDescriptor" ], "type": "object" + }, + "EdFi_ProgramEvaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramEvaluation_TrackedChangeKey": { + "properties": { + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "programEducationOrganizationId", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_ProgramEvaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -220285,7 +274808,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220328,7 +274851,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -220350,6 +274873,128 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programEvaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programEvaluations" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programEvaluations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramEvaluationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramEvaluation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programEvaluations" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programEvaluations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -220385,7 +275030,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -220417,15 +275062,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -220452,7 +275088,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220509,7 +275145,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -220775,6 +275411,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramSponsorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramSponsorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramSponsorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -220891,7 +275588,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -220934,7 +275631,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -220966,6 +275663,148 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programSponsorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramSponsorsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programSponsorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programSponsorDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramSponsorsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramSponsorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programSponsorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programSponsorDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -221001,7 +275840,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -221033,15 +275872,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -221068,7 +275898,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -221125,7 +275955,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -221375,6 +276205,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgramTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgramTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgramTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -221491,7 +276382,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -221534,7 +276425,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -221567,6 +276458,150 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "EducatorPreparationProgram", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgramTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "EducatorPreparationProgram", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -221602,7 +276637,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -221634,15 +276669,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -221669,7 +276695,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -221726,7 +276752,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -222195,6 +277221,72 @@ "programTypeDescriptor" ], "type": "object" + }, + "EdFi_Program_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Program_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "EdFi_Program_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -222294,7 +277386,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -222337,7 +277429,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -222369,6 +277461,148 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/programs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgramsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "programs" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/programs/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgramsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Program_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "programs" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "ReportCard", + "SectionsAndPrograms", + "StudentProgramEvaluation" + ] + }, "/ed-fi/programs/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -222404,7 +277638,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -222436,15 +277670,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -222471,7 +277696,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -222528,7 +277753,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -222763,6 +277988,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgressDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgressDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgressDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -222879,7 +278165,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -222922,7 +278208,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -222943,6 +278229,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/progressDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgressesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "progressDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/progressDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgressesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgressDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "progressDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/progressDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -222978,7 +278384,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -223010,15 +278416,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -223045,7 +278442,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223102,7 +278499,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -223329,6 +278726,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProgressLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProgressLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProgressLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -223445,7 +278903,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223488,7 +278946,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -223509,6 +278967,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/progressLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProgressLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "progressLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/progressLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProgressLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProgressLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "progressLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/progressLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -223544,7 +279122,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -223576,15 +279154,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -223611,7 +279180,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -223668,7 +279237,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -223956,6 +279525,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_ProjectDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProjectDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_ProjectDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -224045,7 +279675,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224088,7 +279718,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -224109,6 +279739,126 @@ "Finance" ] }, + "/ed-fi/projectDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProjectDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "projectDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/projectDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProjectDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProjectDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "projectDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/projectDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -224144,7 +279894,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -224176,15 +279926,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -224211,7 +279952,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224268,7 +280009,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -224476,6 +280217,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProviderCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProviderCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProviderCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -224592,7 +280394,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224635,7 +280437,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -224656,6 +280458,126 @@ "EducationOrganization" ] }, + "/ed-fi/providerCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProviderCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "providerCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/providerCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProviderCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "providerCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/providerCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -224691,7 +280613,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -224723,15 +280645,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -224758,7 +280671,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -224815,7 +280728,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225042,6 +280955,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProviderProfitabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProviderProfitabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -225158,7 +281132,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225201,7 +281175,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225222,6 +281196,126 @@ "EducationOrganization" ] }, + "/ed-fi/providerProfitabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProviderProfitabilitiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "providerProfitabilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/providerProfitabilityDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProviderProfitabilitiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderProfitabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "providerProfitabilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/providerProfitabilityDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -225257,7 +281351,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225289,15 +281383,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -225324,7 +281409,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225381,7 +281466,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225608,6 +281693,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ProviderStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ProviderStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ProviderStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -225724,7 +281870,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225767,7 +281913,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225788,6 +281934,126 @@ "EducationOrganization" ] }, + "/ed-fi/providerStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getProviderStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "providerStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, + "/ed-fi/providerStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getProviderStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ProviderStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "providerStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization" + ] + }, "/ed-fi/providerStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -225823,7 +282089,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -225855,15 +282121,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -225890,7 +282147,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -225947,7 +282204,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -226181,6 +282438,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_PublicationStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_PublicationStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_PublicationStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -226297,7 +282615,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226340,7 +282658,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -226368,6 +282686,140 @@ "Standards" ] }, + "/ed-fi/publicationStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getPublicationStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "publicationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, + "/ed-fi/publicationStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getPublicationStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_PublicationStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "publicationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAcademicRecord", + "TeachingAndLearning", + "AssessmentMetadata", + "CourseCatalog", + "Gradebook", + "ReportCard", + "Standards" + ] + }, "/ed-fi/publicationStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -226403,7 +282855,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -226435,15 +282887,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -226470,7 +282913,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226527,7 +282970,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -226761,6 +283204,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_QuantitativeMeasureDatatypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureDatatypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_QuantitativeMeasureDatatypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_QuantitativeMeasureDatatypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureDatatypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureDatatypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -226877,7 +283381,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -226920,7 +283424,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -226941,6 +283445,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/quantitativeMeasureDatatypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getQuantitativeMeasureDatatypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureDatatypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "quantitativeMeasureDatatypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/quantitativeMeasureDatatypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getQuantitativeMeasureDatatypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureDatatypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "quantitativeMeasureDatatypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/quantitativeMeasureDatatypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -226976,7 +283600,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -227008,15 +283632,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -227043,7 +283658,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -227100,7 +283715,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -227810,6 +284425,127 @@ "quantitativeMeasureIdentifier" ], "type": "object" + }, + "EdFi_QuantitativeMeasureScore_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureScore_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_QuantitativeMeasureScore_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationDate": { + "format": "date-time", + "type": "string" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "quantitativeMeasureIdentifier": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationDate", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "quantitativeMeasureIdentifier", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_QuantitativeMeasureScore_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureScore_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureScore_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -228023,7 +284759,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -228066,7 +284802,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -228087,6 +284823,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/quantitativeMeasureScores/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getQuantitativeMeasureScoresDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureScore_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "quantitativeMeasureScores" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/quantitativeMeasureScores/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getQuantitativeMeasureScoresKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureScore_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "quantitativeMeasureScores" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/quantitativeMeasureScores/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -228122,7 +284978,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -228154,15 +285010,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -228189,7 +285036,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -228246,7 +285093,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -228534,6 +285381,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_QuantitativeMeasureTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_QuantitativeMeasureTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_QuantitativeMeasureTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -228650,7 +285558,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -228693,7 +285601,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -228714,6 +285622,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/quantitativeMeasureTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getQuantitativeMeasureTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "quantitativeMeasureTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/quantitativeMeasureTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getQuantitativeMeasureTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasureTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "quantitativeMeasureTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/quantitativeMeasureTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -228749,7 +285777,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -228781,15 +285809,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -228816,7 +285835,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -228873,7 +285892,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229310,6 +286329,112 @@ "quantitativeMeasureIdentifier" ], "type": "object" + }, + "EdFi_QuantitativeMeasure_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasure_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_QuantitativeMeasure_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "quantitativeMeasureIdentifier": { + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "quantitativeMeasureIdentifier", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_QuantitativeMeasure_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasure_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasure_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -229493,7 +286618,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229536,7 +286661,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229557,6 +286682,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/quantitativeMeasures/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getQuantitativeMeasuresDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasure_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "quantitativeMeasures" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/quantitativeMeasures/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getQuantitativeMeasuresKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuantitativeMeasure_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "quantitativeMeasures" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/quantitativeMeasures/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -229592,7 +286837,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229624,15 +286869,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -229659,7 +286895,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -229716,7 +286952,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -229982,6 +287218,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_QuestionFormDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_QuestionFormDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_QuestionFormDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -230098,7 +287395,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230141,7 +287438,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230162,6 +287459,126 @@ "Survey" ] }, + "/ed-fi/questionFormDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getQuestionFormsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "questionFormDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/questionFormDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getQuestionFormsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_QuestionFormDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "questionFormDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/questionFormDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -230197,7 +287614,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230229,15 +287646,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -230264,7 +287672,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230321,7 +287729,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230553,6 +287961,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RaceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RaceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RaceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -230669,7 +288138,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230712,7 +288181,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230738,6 +288207,136 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/raceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRacesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "raceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "Staff", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/raceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRacesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RaceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "raceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "Staff", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/raceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -230773,7 +288372,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -230805,15 +288404,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -230840,7 +288430,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -230897,7 +288487,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231130,6 +288720,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -231246,7 +288897,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231289,7 +288940,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231311,6 +288962,128 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/ratingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "ratingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/ratingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "ratingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/ratingLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -231346,7 +289119,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231378,15 +289151,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -231413,7 +289177,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231470,7 +289234,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231700,6 +289464,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReasonExitedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReasonExitedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReasonExitedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -231816,7 +289641,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -231859,7 +289684,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231882,6 +289707,130 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/reasonExitedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReasonExitedsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "reasonExitedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "EducatorPreparationProgram", + "SpecialEducationDataModel" + ] + }, + "/ed-fi/reasonExitedDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReasonExitedsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReasonExitedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "reasonExitedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "EducatorPreparationProgram", + "SpecialEducationDataModel" + ] + }, "/ed-fi/reasonExitedDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -231917,7 +289866,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -231949,15 +289898,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -231984,7 +289924,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232041,7 +289981,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -232271,6 +290211,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReasonNotTestedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReasonNotTestedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReasonNotTestedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -232387,7 +290388,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232430,7 +290431,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -232452,6 +290453,128 @@ "StudentAssessment" ] }, + "/ed-fi/reasonNotTestedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReasonNotTestedsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "reasonNotTestedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/reasonNotTestedDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReasonNotTestedsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReasonNotTestedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "reasonNotTestedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, "/ed-fi/reasonNotTestedDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -232487,7 +290610,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -232519,15 +290642,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -232554,7 +290668,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -232611,7 +290725,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -232852,6 +290966,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RecognitionTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RecognitionTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RecognitionTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -232968,7 +291143,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233011,7 +291186,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -233045,6 +291220,152 @@ "StudentTranscript" ] }, + "/ed-fi/recognitionTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRecognitionTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "recognitionTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Graduation", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/recognitionTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRecognitionTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecognitionTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "recognitionTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Graduation", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/recognitionTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -233080,7 +291401,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -233112,15 +291433,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -233147,7 +291459,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -233204,7 +291516,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -234744,6 +293056,78 @@ "touchpointDate" ], "type": "object" + }, + "EdFi_RecruitmentEventAttendance_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RecruitmentEventAttendance_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "eventTitle": { + "maxLength": 50, + "type": "string" + }, + "recruitmentEventAttendeeIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "eventDate", + "eventTitle", + "recruitmentEventAttendeeIdentifier" + ], + "type": "object" + }, + "EdFi_RecruitmentEventAttendance_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendance_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendance_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -235035,7 +293419,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235078,7 +293462,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235099,6 +293483,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/recruitmentEventAttendances/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRecruitmentEventAttendancesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendance_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "recruitmentEventAttendances" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/recruitmentEventAttendances/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRecruitmentEventAttendancesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendance_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "recruitmentEventAttendances" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/recruitmentEventAttendances/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -235134,7 +293638,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235166,15 +293670,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -235201,7 +293696,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235258,7 +293753,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235610,6 +294105,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RecruitmentEventAttendeeTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendeeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RecruitmentEventAttendeeTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RecruitmentEventAttendeeTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendeeTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendeeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -235726,7 +294282,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235769,7 +294325,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235790,6 +294346,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/recruitmentEventAttendeeTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRecruitmentEventAttendeeTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendeeTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "recruitmentEventAttendeeTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/recruitmentEventAttendeeTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRecruitmentEventAttendeeTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventAttendeeTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "recruitmentEventAttendeeTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/recruitmentEventAttendeeTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -235825,7 +294501,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -235857,15 +294533,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -235892,7 +294559,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -235949,7 +294616,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236176,6 +294843,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RecruitmentEventTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RecruitmentEventTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RecruitmentEventTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -236292,7 +295020,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236335,7 +295063,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236356,6 +295084,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/recruitmentEventTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRecruitmentEventTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "recruitmentEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/recruitmentEventTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRecruitmentEventTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecruitmentEventTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "recruitmentEventTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/recruitmentEventTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -236391,7 +295239,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236423,15 +295271,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -236458,7 +295297,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236515,7 +295354,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -236826,6 +295665,72 @@ "eventTitle" ], "type": "object" + }, + "EdFi_RecruitmentEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RecruitmentEvent_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "eventTitle": { + "maxLength": 50, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "eventDate", + "eventTitle" + ], + "type": "object" + }, + "EdFi_RecruitmentEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RecruitmentEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -236943,7 +295848,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -236986,7 +295891,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237007,6 +295912,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/recruitmentEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRecruitmentEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecruitmentEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "recruitmentEvents" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/recruitmentEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRecruitmentEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RecruitmentEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "recruitmentEvents" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/recruitmentEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -237042,7 +296067,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237074,15 +296099,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -237109,7 +296125,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237166,7 +296182,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237396,6 +296412,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RelationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RelationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RelationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -237512,7 +296589,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237555,7 +296632,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237576,6 +296653,126 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/relationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRelationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "relationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/relationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRelationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RelationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "relationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/relationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -237611,7 +296808,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237643,15 +296840,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -237678,7 +296866,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -237735,7 +296923,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -237970,6 +297158,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RepeatIdentifierDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RepeatIdentifierDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RepeatIdentifierDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -238086,7 +297335,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238129,7 +297378,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238158,6 +297407,142 @@ "SectionsAndPrograms" ] }, + "/ed-fi/repeatIdentifierDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRepeatIdentifiersDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "repeatIdentifierDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/repeatIdentifierDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRepeatIdentifiersKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RepeatIdentifierDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "repeatIdentifierDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/repeatIdentifierDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -238193,7 +297578,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -238225,15 +297610,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -238260,7 +297636,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -238317,7 +297693,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239231,6 +298607,87 @@ "studentCompetencyObjectiveReference" ], "type": "object" + }, + "EdFi_ReportCard_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReportCard_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "type": "string" + }, + "gradingPeriodSchoolId": { + "format": "int64", + "type": "integer" + }, + "gradingPeriodSchoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolId", + "gradingPeriodSchoolYear", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_ReportCard_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -239378,7 +298835,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239421,7 +298878,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239443,6 +298900,128 @@ "ReportCard" ] }, + "/ed-fi/reportCards/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReportCardsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "reportCards" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/reportCards/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReportCardsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReportCard_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "reportCards" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, "/ed-fi/reportCards/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -239478,7 +299057,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239510,15 +299089,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -239545,7 +299115,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -239602,7 +299172,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -239857,6 +299427,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReporterDescriptionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReporterDescriptionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReporterDescriptionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -239973,7 +299604,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240016,7 +299647,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240037,6 +299668,126 @@ "Discipline" ] }, + "/ed-fi/reporterDescriptionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReporterDescriptionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "reporterDescriptionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/reporterDescriptionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReporterDescriptionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReporterDescriptionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "reporterDescriptionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/reporterDescriptionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -240072,7 +299823,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240104,15 +299855,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -240139,7 +299881,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240196,7 +299938,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240423,6 +300165,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ReportingTagDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ReportingTagDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ReportingTagDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -240539,7 +300342,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240582,7 +300385,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240603,6 +300406,126 @@ "Finance" ] }, + "/ed-fi/reportingTagDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getReportingTagsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "reportingTagDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/reportingTagDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getReportingTagsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ReportingTagDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "reportingTagDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/reportingTagDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -240638,7 +300561,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240670,15 +300593,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -240705,7 +300619,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -240762,7 +300676,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -240993,6 +300907,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResidencyStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResidencyStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResidencyStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -241109,7 +301084,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241152,7 +301127,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241177,6 +301152,134 @@ "SectionsAndPrograms" ] }, + "/ed-fi/residencyStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResidencyStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "residencyStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/residencyStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResidencyStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResidencyStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "residencyStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/residencyStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -241212,7 +301315,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241244,15 +301347,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -241279,7 +301373,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241336,7 +301430,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241568,6 +301662,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResponseIndicatorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResponseIndicatorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResponseIndicatorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -241684,7 +301839,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241727,7 +301882,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241749,6 +301904,128 @@ "StudentAssessment" ] }, + "/ed-fi/responseIndicatorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResponseIndicatorsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "responseIndicatorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/responseIndicatorDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResponseIndicatorsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResponseIndicatorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "responseIndicatorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, "/ed-fi/responseIndicatorDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -241784,7 +302061,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -241816,15 +302093,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -241851,7 +302119,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -241908,7 +302176,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242136,6 +302404,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResponsibilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResponsibilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResponsibilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -242252,7 +302581,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242295,7 +302624,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242316,6 +302645,126 @@ "Enrollment" ] }, + "/ed-fi/responsibilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResponsibilitiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "responsibilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/responsibilityDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResponsibilitiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResponsibilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "responsibilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/responsibilityDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -242351,7 +302800,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242383,15 +302832,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -242418,7 +302858,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242475,7 +302915,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242702,6 +303142,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RestraintEventReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RestraintEventReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RestraintEventReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -242818,7 +303319,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -242861,7 +303362,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242882,6 +303383,126 @@ "SpecialEducation" ] }, + "/ed-fi/restraintEventReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "restraintEventReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, + "/ed-fi/restraintEventReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEventReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "restraintEventReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, "/ed-fi/restraintEventReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -242917,7 +303538,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -242949,15 +303570,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -242984,7 +303596,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243041,7 +303653,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243541,6 +304153,72 @@ "restraintEventReasonDescriptor" ], "type": "object" + }, + "EdFi_RestraintEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RestraintEvent_TrackedChangeKey": { + "properties": { + "restraintEventIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "restraintEventIdentifier", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_RestraintEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -243659,7 +304337,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243702,7 +304380,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243723,6 +304401,126 @@ "SpecialEducation" ] }, + "/ed-fi/restraintEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "restraintEvents" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, + "/ed-fi/restraintEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRestraintEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RestraintEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "restraintEvents" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation" + ] + }, "/ed-fi/restraintEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -243758,7 +304556,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -243790,15 +304588,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -243825,7 +304614,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -243882,7 +304671,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244124,6 +304913,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ResultDatatypeTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -244240,7 +305090,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244283,7 +305133,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244310,6 +305160,138 @@ "StudentAssessment" ] }, + "/ed-fi/resultDatatypeTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getResultDatatypeTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "resultDatatypeTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "Enrollment", + "Graduation", + "PerformanceEvaluation", + "RecruitingAndStaffing", + "AssessmentMetadata", + "StudentAssessment" + ] + }, + "/ed-fi/resultDatatypeTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getResultDatatypeTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ResultDatatypeTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "resultDatatypeTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "Enrollment", + "Graduation", + "PerformanceEvaluation", + "RecruitingAndStaffing", + "AssessmentMetadata", + "StudentAssessment" + ] + }, "/ed-fi/resultDatatypeTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -244345,7 +305327,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244377,15 +305359,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -244412,7 +305385,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244469,7 +305442,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244703,6 +305676,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RetestIndicatorDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RetestIndicatorDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RetestIndicatorDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -244819,7 +305853,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -244862,7 +305896,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244884,6 +305918,128 @@ "StudentAssessment" ] }, + "/ed-fi/retestIndicatorDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRetestIndicatorsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "retestIndicatorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/retestIndicatorDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRetestIndicatorsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RetestIndicatorDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "retestIndicatorDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, "/ed-fi/retestIndicatorDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -244919,7 +306075,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -244951,15 +306107,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -244986,7 +306133,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245043,7 +306190,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245496,6 +306643,111 @@ "rubricRating" ], "type": "object" + }, + "EdFi_RubricDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RubricDimension_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "rubricRating": { + "format": "int32", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "rubricRating", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_RubricDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RubricDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -245687,7 +306939,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245730,7 +306982,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245751,6 +307003,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/rubricDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRubricDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RubricDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "rubricDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/rubricDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRubricDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RubricDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "rubricDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/rubricDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -245786,7 +307158,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -245818,15 +307190,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -245853,7 +307216,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -245910,7 +307273,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246182,6 +307545,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_RubricRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_RubricRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_RubricRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_RubricRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_RubricRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_RubricRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -246298,7 +307722,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246341,7 +307765,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246362,6 +307786,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/rubricRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getRubricRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RubricRatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "rubricRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/rubricRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getRubricRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_RubricRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "rubricRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/rubricRatingLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -246397,7 +307941,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246429,15 +307973,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -246464,7 +307999,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246521,7 +308056,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246748,6 +308283,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SalaryTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SalaryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SalaryTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SalaryTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SalaryTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SalaryTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -246864,7 +308460,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -246907,7 +308503,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246928,6 +308524,126 @@ "Staff" ] }, + "/ed-fi/salaryTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSalaryTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SalaryTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "salaryTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/salaryTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSalaryTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SalaryTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "salaryTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/salaryTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -246963,7 +308679,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -246995,15 +308711,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -247030,7 +308737,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247087,7 +308794,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247327,6 +309034,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -247443,7 +309211,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247486,7 +309254,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247520,6 +309288,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/schoolCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/schoolCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/schoolCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -247555,7 +309469,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247587,15 +309501,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -247622,7 +309527,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -247679,7 +309584,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -247923,6 +309828,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolChoiceBasisDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -248039,7 +310005,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248082,7 +310048,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248107,6 +310073,134 @@ "SectionsAndPrograms" ] }, + "/ed-fi/schoolChoiceBasisDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceBasesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolChoiceBasisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/schoolChoiceBasisDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceBasesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceBasisDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolChoiceBasisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/schoolChoiceBasisDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -248142,7 +310236,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248174,15 +310268,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -248209,7 +310294,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248266,7 +310351,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248499,6 +310584,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -248615,7 +310761,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248658,7 +310804,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248681,6 +310827,130 @@ "Staff" ] }, + "/ed-fi/schoolChoiceImplementStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceImplementStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolChoiceImplementStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, + "/ed-fi/schoolChoiceImplementStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolChoiceImplementStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolChoiceImplementStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolChoiceImplementStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Enrollment", + "Staff" + ] + }, "/ed-fi/schoolChoiceImplementStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -248716,7 +310986,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -248748,15 +311018,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -248783,7 +311044,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -248840,7 +311101,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249069,6 +311330,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -249185,7 +311507,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249228,7 +311550,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249249,6 +311571,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/schoolFoodServiceProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolFoodServiceProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolFoodServiceProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/schoolFoodServiceProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolFoodServiceProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolFoodServiceProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolFoodServiceProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/schoolFoodServiceProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -249284,7 +311726,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249316,15 +311758,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -249351,7 +311784,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249408,7 +311841,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249648,6 +312081,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SchoolTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SchoolTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -249764,7 +312258,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -249807,7 +312301,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249841,6 +312335,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/schoolTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/schoolTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/schoolTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -249876,7 +312516,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -249908,15 +312548,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -249943,7 +312574,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250000,7 +312631,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250208,6 +312839,62 @@ "schoolYear" ], "type": "object" + }, + "EdFi_SchoolYear_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SchoolYear_TrackedChangeKey": { + "properties": { + "schoolYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "schoolYear" + ], + "type": "object" + }, + "EdFi_SchoolYear_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -250293,7 +312980,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250336,7 +313023,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250356,6 +313043,124 @@ "x-Ed-Fi-domains": [ ] }, + "/ed-fi/schoolYearTypes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolYearsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolYearTypes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/ed-fi/schoolYearTypes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolYearsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SchoolYear_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolYearTypes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/ed-fi/schoolYearTypes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -250391,7 +313196,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -250423,15 +313228,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -250458,7 +313254,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -250515,7 +313311,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252174,6 +314970,62 @@ "schoolCategoryDescriptor" ], "type": "object" + }, + "EdFi_School_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_School_TrackedChangeKey": { + "properties": { + "schoolId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "schoolId" + ], + "type": "object" + }, + "EdFi_School_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -252399,7 +315251,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252442,7 +315294,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252476,6 +315328,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/schools/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schools" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/schools/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSchoolsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_School_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schools" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/schools/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -252511,7 +315509,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252543,15 +315541,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -252578,7 +315567,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -252635,7 +315624,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -252962,6 +315951,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_Section504DisabilityDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Section504DisabilityDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_Section504DisabilityDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -253078,7 +316128,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253121,7 +316171,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -253142,6 +316192,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/section504DisabilityDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSection504DisabilitiesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "section504DisabilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/section504DisabilityDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSection504DisabilitiesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Section504DisabilityDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "section504DisabilityDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/section504DisabilityDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -253177,7 +316347,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -253209,15 +316379,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -253244,7 +316405,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253301,7 +316462,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -253732,6 +316893,92 @@ "sectionIdentifier" ], "type": "object" + }, + "EdFi_SectionAttendanceTakenEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SectionAttendanceTakenEvent_TrackedChangeKey": { + "properties": { + "calendarCode": { + "maxLength": 120, + "type": "string" + }, + "date": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "calendarCode", + "date", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName" + ], + "type": "object" + }, + "EdFi_SectionAttendanceTakenEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -253881,7 +317128,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -253924,7 +317171,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -253945,6 +317192,126 @@ "StudentAttendance" ] }, + "/ed-fi/sectionAttendanceTakenEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionAttendanceTakenEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "sectionAttendanceTakenEvents" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAttendance" + ] + }, + "/ed-fi/sectionAttendanceTakenEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionAttendanceTakenEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionAttendanceTakenEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "sectionAttendanceTakenEvents" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAttendance" + ] + }, "/ed-fi/sectionAttendanceTakenEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -253980,7 +317347,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -254012,15 +317379,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -254047,7 +317405,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254104,7 +317462,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -254368,6 +317726,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SectionCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SectionCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SectionCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -254484,7 +317903,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254527,7 +317946,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -254560,6 +317979,150 @@ "SectionsAndPrograms" ] }, + "/ed-fi/sectionCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionCharacteristicsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "sectionCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sectionCharacteristicDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionCharacteristicsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "sectionCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/sectionCharacteristicDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -254595,7 +318158,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -254627,15 +318190,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -254662,7 +318216,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -254719,7 +318273,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -254970,6 +318524,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SectionTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SectionTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SectionTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -255086,7 +318701,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255129,7 +318744,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -255162,6 +318777,150 @@ "SectionsAndPrograms" ] }, + "/ed-fi/sectionTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "sectionTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sectionTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SectionTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "sectionTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/sectionTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -255197,7 +318956,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -255229,15 +318988,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -255264,7 +319014,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -255321,7 +319071,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -256280,6 +320030,82 @@ "sectionCharacteristicDescriptor" ], "type": "object" + }, + "EdFi_Section_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Section_TrackedChangeKey": { + "properties": { + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName" + ], + "type": "object" + }, + "EdFi_Section_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -256508,7 +320334,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256551,7 +320377,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -256584,6 +320410,150 @@ "SectionsAndPrograms" ] }, + "/ed-fi/sections/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "sections" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sections/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Section_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "sections" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "AssessmentMetadata", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/sections/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -256619,7 +320589,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -256651,15 +320621,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -256686,7 +320647,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -256743,7 +320704,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257065,6 +321026,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SeparationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SeparationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SeparationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -257181,7 +321203,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257224,7 +321246,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257245,6 +321267,126 @@ "Staff" ] }, + "/ed-fi/separationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "separationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/separationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SeparationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "separationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/separationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -257280,7 +321422,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257312,15 +321454,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -257347,7 +321480,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257404,7 +321537,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257631,6 +321764,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SeparationReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SeparationReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SeparationReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -257747,7 +321941,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257790,7 +321984,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257811,6 +322005,126 @@ "Staff" ] }, + "/ed-fi/separationReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "separationReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/separationReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSeparationReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SeparationReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "separationReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/separationReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -257846,7 +322160,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -257878,15 +322192,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -257913,7 +322218,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -257970,7 +322275,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -258197,6 +322502,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ServiceDeliveryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDeliveryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ServiceDeliveryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ServiceDeliveryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDeliveryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDeliveryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -258313,7 +322679,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258356,7 +322722,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -258377,6 +322743,126 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/serviceDeliveryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getServiceDeliveriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ServiceDeliveryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "serviceDeliveryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, + "/ed-fi/serviceDeliveryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getServiceDeliveriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ServiceDeliveryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "serviceDeliveryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, "/ed-fi/serviceDeliveryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -258412,7 +322898,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -258444,15 +322930,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -258479,7 +322956,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258536,7 +323013,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -258769,6 +323246,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -258885,7 +323423,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -258928,7 +323466,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -258955,6 +323493,138 @@ "SectionsAndPrograms" ] }, + "/ed-fi/serviceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "serviceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/serviceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "serviceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/serviceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -258990,7 +323660,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -259022,15 +323692,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -259057,7 +323718,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -259114,7 +323775,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -259347,6 +324008,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ServiceLocationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ServiceLocationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ServiceLocationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ServiceLocationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ServiceLocationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ServiceLocationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -259463,7 +324185,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -259506,7 +324228,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -259527,6 +324249,126 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/serviceLocationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getServiceLocationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ServiceLocationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "serviceLocationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, + "/ed-fi/serviceLocationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getServiceLocationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ServiceLocationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "serviceLocationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, "/ed-fi/serviceLocationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -259562,7 +324404,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -259594,15 +324436,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -259629,7 +324462,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -259686,7 +324519,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -259913,6 +324746,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ServicePrescriptionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ServicePrescriptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ServicePrescriptionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ServicePrescriptionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ServicePrescriptionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ServicePrescriptionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -260029,7 +324923,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -260072,7 +324966,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -260093,6 +324987,126 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/servicePrescriptionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getServicePrescriptionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ServicePrescriptionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "servicePrescriptionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, + "/ed-fi/servicePrescriptionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getServicePrescriptionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ServicePrescriptionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "servicePrescriptionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, "/ed-fi/servicePrescriptionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -260128,7 +325142,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -260160,15 +325174,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -260195,7 +325200,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -260252,7 +325257,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -260479,6 +325484,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_ServiceProviderTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_ServiceProviderTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_ServiceProviderTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_ServiceProviderTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_ServiceProviderTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_ServiceProviderTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -260595,7 +325661,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -260638,7 +325704,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -260659,6 +325725,126 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/serviceProviderTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getServiceProviderTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ServiceProviderTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "serviceProviderTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, + "/ed-fi/serviceProviderTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getServiceProviderTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_ServiceProviderTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "serviceProviderTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, "/ed-fi/serviceProviderTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -260694,7 +325880,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -260726,15 +325912,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -260761,7 +325938,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -260818,7 +325995,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -261367,6 +326544,72 @@ "sessionName" ], "type": "object" + }, + "EdFi_Session_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Session_TrackedChangeKey": { + "properties": { + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "schoolId", + "schoolYear", + "sessionName" + ], + "type": "object" + }, + "EdFi_Session_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -261493,7 +326736,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -261536,7 +326779,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -261564,6 +326807,140 @@ "SectionsAndPrograms" ] }, + "/ed-fi/sessions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSessionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "sessions" + ] + }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "SchoolCalendar", + "StudentAcademicRecord", + "StudentAttendance", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/sessions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSessionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Session_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "sessions" + ] + }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "SchoolCalendar", + "StudentAcademicRecord", + "StudentAttendance", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/sessions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -261599,7 +326976,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -261631,15 +327008,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -261666,7 +327034,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -261723,7 +327091,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -261990,6 +327358,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SexDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SexDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SexDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -262106,7 +327535,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -262149,7 +327578,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -262193,6 +327622,172 @@ "StudentTranscript" ] }, + "/ed-fi/sexDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSexesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "sexDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "AssessmentRegistration", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/sexDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSexesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SexDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "sexDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "AssessmentRegistration", + "Discipline", + "EducatorPreparationProgram", + "Enrollment", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/sexDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -262228,7 +327823,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -262260,15 +327855,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -262295,7 +327881,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -262352,7 +327938,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -262663,6 +328249,67 @@ "reportingTagDescriptor" ], "type": "object" + }, + "EdFi_SourceDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SourceDimension_TrackedChangeKey": { + "properties": { + "code": { + "maxLength": 16, + "type": "string" + }, + "fiscalYear": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "code", + "fiscalYear" + ], + "type": "object" + }, + "EdFi_SourceDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -262752,7 +328399,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -262795,7 +328442,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -262816,6 +328463,126 @@ "Finance" ] }, + "/ed-fi/sourceDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSourceDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "sourceDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, + "/ed-fi/sourceDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSourceDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SourceDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "sourceDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "Finance" + ] + }, "/ed-fi/sourceDimensions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -262851,7 +328618,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -262883,15 +328650,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -262918,7 +328676,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -262975,7 +328733,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -263184,6 +328942,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SourceSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SourceSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SourceSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -263300,7 +329119,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -263343,7 +329162,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -263365,6 +329184,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/sourceSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSourceSystemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "sourceSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/sourceSystemDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSourceSystemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SourceSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "sourceSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/sourceSystemDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -263400,7 +329341,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -263432,15 +329373,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -263467,7 +329399,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -263524,7 +329456,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -263753,6 +329685,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -263869,7 +329862,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -263912,7 +329905,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -263934,6 +329927,128 @@ "SpecialEducation" ] }, + "/ed-fi/specialEducationExitReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationExitReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "specialEducationExitReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation" + ] + }, + "/ed-fi/specialEducationExitReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationExitReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationExitReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "specialEducationExitReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation" + ] + }, "/ed-fi/specialEducationExitReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -263969,7 +330084,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -264001,15 +330116,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -264036,7 +330142,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -264093,7 +330199,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -264322,6 +330428,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -264438,7 +330605,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -264481,7 +330648,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -264503,6 +330670,128 @@ "SpecialEducation" ] }, + "/ed-fi/specialEducationProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "specialEducationProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation" + ] + }, + "/ed-fi/specialEducationProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "specialEducationProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation" + ] + }, "/ed-fi/specialEducationProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -264538,7 +330827,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -264570,15 +330859,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -264605,7 +330885,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -264662,7 +330942,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -264892,6 +331172,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SpecialEducationSettingDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SpecialEducationSettingDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -265008,7 +331349,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -265051,7 +331392,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -265074,6 +331415,130 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/specialEducationSettingDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationSettingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "specialEducationSettingDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "SpecialEducationDataModel" + ] + }, + "/ed-fi/specialEducationSettingDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSpecialEducationSettingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SpecialEducationSettingDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "specialEducationSettingDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "SpecialEducationDataModel" + ] + }, "/ed-fi/specialEducationSettingDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -265109,7 +331574,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -265141,15 +331606,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -265176,7 +331632,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -265233,7 +331689,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -265531,6 +331987,72 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffAbsenceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffAbsenceEvent_TrackedChangeKey": { + "properties": { + "absenceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "absenceEventCategoryDescriptor", + "eventDate", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffAbsenceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -265639,7 +332161,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -265682,7 +332204,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -265703,6 +332225,126 @@ "Staff" ] }, + "/ed-fi/staffAbsenceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffAbsenceEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffAbsenceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffAbsenceEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffAbsenceEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffAbsenceEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffAbsenceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffAbsenceEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -265738,7 +332380,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -265770,15 +332412,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -265805,7 +332438,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -265862,7 +332495,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -266083,6 +332716,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffClassificationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffClassificationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffClassificationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -266199,7 +332893,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -266242,7 +332936,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -266263,6 +332957,126 @@ "Staff" ] }, + "/ed-fi/staffClassificationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffClassificationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffClassificationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffClassificationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffClassificationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffClassificationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffClassificationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffClassificationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -266298,7 +333112,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -266330,15 +333144,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -266365,7 +333170,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -266422,7 +333227,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -266746,6 +333551,77 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffCohortAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffCohortAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "cohortIdentifier": { + "maxLength": 36, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "cohortIdentifier", + "educationOrganizationId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffCohortAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -266863,7 +333739,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -266906,7 +333782,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -266927,6 +333803,126 @@ "StudentCohort" ] }, + "/ed-fi/staffCohortAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffCohortAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffCohortAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "StudentCohort" + ] + }, + "/ed-fi/staffCohortAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffCohortAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffCohortAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffCohortAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "StudentCohort" + ] + }, "/ed-fi/staffCohortAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -266962,7 +333958,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -266994,15 +333990,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -267029,7 +334016,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -267086,7 +334073,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -267888,6 +334875,67 @@ ], "type": "object" }, + "EdFi_StaffDemographic_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffDemographic_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffDemographic_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffDemographic_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDemographic_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDemographic_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_StaffDemographic_TribalAffiliation": { "properties": { "tribalAffiliationDescriptor": { @@ -268015,7 +335063,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -268058,7 +335106,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -268079,6 +335127,126 @@ "Staff" ] }, + "/ed-fi/staffDemographics/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDemographicsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffDemographic_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffDemographics" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffDemographics/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDemographicsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffDemographic_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffDemographics" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffDemographics/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -268114,7 +335282,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -268146,15 +335314,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -268181,7 +335340,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -268238,7 +335397,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -269389,6 +336548,67 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "EdFi_StaffDirectory_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffDirectory_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffDirectory_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffDirectory_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDirectory_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDirectory_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -269469,7 +336689,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -269512,7 +336732,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -269533,6 +336753,126 @@ "Staff" ] }, + "/ed-fi/staffDirectories/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDirectoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffDirectory_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffDirectories" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffDirectories/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDirectoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffDirectory_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffDirectories" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffDirectories/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -269568,7 +336908,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -269600,15 +336940,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -269635,7 +336966,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -269692,7 +337023,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -269988,6 +337319,72 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffDisciplineIncidentAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey": { + "properties": { + "incidentIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "incidentIdentifier", + "schoolId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -270078,7 +337475,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -270121,7 +337518,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -270142,6 +337539,126 @@ "Discipline" ] }, + "/ed-fi/staffDisciplineIncidentAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDisciplineIncidentAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffDisciplineIncidentAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/staffDisciplineIncidentAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffDisciplineIncidentAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffDisciplineIncidentAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffDisciplineIncidentAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/staffDisciplineIncidentAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -270177,7 +337694,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -270209,15 +337726,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -270244,7 +337752,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -270301,7 +337809,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -270807,6 +338315,77 @@ "staffClassificationDescriptor" ], "type": "object" + }, + "EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffClassificationDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "staffClassificationDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -271002,7 +338581,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -271045,7 +338624,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -271066,6 +338645,126 @@ "Staff" ] }, + "/ed-fi/staffEducationOrganizationAssignmentAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationAssignmentAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffEducationOrganizationAssignmentAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationAssignmentAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationAssignmentAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationAssignmentAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffEducationOrganizationAssignmentAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffEducationOrganizationAssignmentAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -271101,7 +338800,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -271133,15 +338832,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -271168,7 +338858,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -271225,7 +338915,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -272197,6 +339887,77 @@ "yearsExperience" ], "type": "object" + }, + "EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "employmentStatusDescriptor": { + "maxLength": 306, + "type": "string" + }, + "hireDate": { + "format": "date", + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "employmentStatusDescriptor", + "hireDate", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -272423,7 +340184,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -272466,7 +340227,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -272487,6 +340248,126 @@ "Staff" ] }, + "/ed-fi/staffEducationOrganizationEmploymentAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationEmploymentAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffEducationOrganizationEmploymentAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffEducationOrganizationEmploymentAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducationOrganizationEmploymentAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducationOrganizationEmploymentAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffEducationOrganizationEmploymentAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffEducationOrganizationEmploymentAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -272522,7 +340403,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -272554,15 +340435,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -272589,7 +340461,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -272646,7 +340518,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -273058,6 +340930,78 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffEducatorPreparationProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducatorPreparationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffEducatorPreparationProgramAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffEducatorPreparationProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducatorPreparationProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffEducatorPreparationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -273185,7 +341129,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -273228,7 +341172,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -273249,6 +341193,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/staffEducatorPreparationProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducatorPreparationProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducatorPreparationProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffEducatorPreparationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/staffEducatorPreparationProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffEducatorPreparationProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffEducatorPreparationProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffEducatorPreparationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/staffEducatorPreparationProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -273284,7 +341348,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -273316,15 +341380,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -273351,7 +341406,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -273408,7 +341463,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -273726,6 +341781,72 @@ "staffIdentificationSystemDescriptor" ], "type": "object" + }, + "EdFi_StaffIdentificationCode_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffIdentificationCode_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "staffIdentificationSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "staffIdentificationSystemDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffIdentificationCode_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationCode_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -273834,7 +341955,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -273877,7 +341998,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -273898,6 +342019,126 @@ "Staff" ] }, + "/ed-fi/staffIdentificationCodes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffIdentificationCodesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationCode_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffIdentificationCodes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffIdentificationCodesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationCode_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffIdentificationCodes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -273933,7 +342174,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -273965,15 +342206,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -274000,7 +342232,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -274057,7 +342289,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -274282,6 +342514,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -274398,7 +342691,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -274441,7 +342734,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -274462,6 +342755,126 @@ "Staff" ] }, + "/ed-fi/staffIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffIdentificationSystemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffIdentificationSystemDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffIdentificationSystemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffIdentificationSystemDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -274497,7 +342910,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -274529,15 +342942,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -274564,7 +342968,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -274621,7 +343025,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -274848,6 +343252,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -274964,7 +343429,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -275007,7 +343472,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -275028,6 +343493,126 @@ "Staff" ] }, + "/ed-fi/staffLeaveEventCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeaveEventCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffLeaveEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffLeaveEventCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeaveEventCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeaveEventCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffLeaveEventCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffLeaveEventCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -275063,7 +343648,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -275095,15 +343680,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -275130,7 +343706,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -275187,7 +343763,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -275496,6 +344072,72 @@ "staffLeaveEventCategoryDescriptor" ], "type": "object" + }, + "EdFi_StaffLeave_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffLeave_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "staffLeaveEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "staffLeaveEventCategoryDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffLeave_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -275612,7 +344254,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -275655,7 +344297,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -275676,6 +344318,126 @@ "Staff" ] }, + "/ed-fi/staffLeaves/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeavesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffLeaves" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, + "/ed-fi/staffLeaves/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffLeavesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffLeave_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffLeaves" + ] + }, + "x-Ed-Fi-domains": [ + "Staff" + ] + }, "/ed-fi/staffLeaves/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -275711,7 +344473,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -275743,15 +344505,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -275778,7 +344531,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -275835,7 +344588,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -276181,6 +344934,82 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -276308,7 +345137,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -276351,7 +345180,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -276375,6 +345204,132 @@ "SectionsAndPrograms" ] }, + "/ed-fi/staffProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/staffProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -276410,7 +345365,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -276442,15 +345397,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -276477,7 +345423,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -276534,7 +345480,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -277032,6 +345978,72 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffSchoolAssociation_TrackedChangeKey": { + "properties": { + "programAssignmentDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "programAssignmentDescriptor", + "schoolId", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -277141,7 +346153,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -277184,7 +346196,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -277207,6 +346219,130 @@ "SectionsAndPrograms" ] }, + "/ed-fi/staffSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSchoolAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffSchoolAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffSchoolAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSchoolAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffSchoolAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Staff", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/staffSchoolAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -277242,7 +346378,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -277274,15 +346410,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -277309,7 +346436,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -277366,7 +346493,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -277818,6 +346945,92 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_StaffSectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffSectionAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_StaffSectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -277991,7 +347204,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -278034,7 +347247,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -278058,6 +347271,132 @@ "SectionsAndPrograms" ] }, + "/ed-fi/staffSectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSectionAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffSectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffSectionAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffSectionAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffSectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffSectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducation", + "StudentCohort", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/staffSectionAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -278093,7 +347432,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -278125,15 +347464,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -278160,7 +347490,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -278217,7 +347547,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -278487,6 +347817,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StaffToCandidateRelationshipDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StaffToCandidateRelationshipDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StaffToCandidateRelationshipDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StaffToCandidateRelationshipDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffToCandidateRelationshipDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StaffToCandidateRelationshipDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -278603,7 +347994,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -278646,7 +348037,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -278667,6 +348058,126 @@ "EducatorPreparationProgram" ] }, + "/ed-fi/staffToCandidateRelationshipDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffToCandidateRelationshipsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffToCandidateRelationshipDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffToCandidateRelationshipDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, + "/ed-fi/staffToCandidateRelationshipDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffToCandidateRelationshipsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StaffToCandidateRelationshipDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffToCandidateRelationshipDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram" + ] + }, "/ed-fi/staffToCandidateRelationshipDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -278702,7 +348213,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -278734,15 +348245,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -278769,7 +348271,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -278826,7 +348328,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -280272,6 +349774,62 @@ "staffUniqueId" ], "type": "object" + }, + "EdFi_Staff_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Staff_TrackedChangeKey": { + "properties": { + "staffUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "staffUniqueId" + ], + "type": "object" + }, + "EdFi_Staff_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -280507,7 +350065,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -280550,7 +350108,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -280581,6 +350139,146 @@ "SectionsAndPrograms" ] }, + "/ed-fi/staffs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStaffsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffs" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/staffs/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStaffsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Staff_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffs" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Discipline", + "Finance", + "Intervention", + "SpecialEducation", + "Staff", + "StudentAttendance", + "StudentCohort", + "Survey", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/staffs/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -280616,7 +350314,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -280648,15 +350346,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -280683,7 +350372,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -280740,7 +350429,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -281090,6 +350779,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StateAbbreviationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StateAbbreviationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StateAbbreviationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -281206,7 +350956,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -281249,7 +350999,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -281297,6 +351047,180 @@ "StudentTranscript" ] }, + "/ed-fi/stateAbbreviationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStateAbbreviationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "stateAbbreviationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Credential", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/stateAbbreviationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStateAbbreviationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StateAbbreviationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "stateAbbreviationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "BellSchedule", + "Credential", + "Discipline", + "EducationOrganization", + "EducatorPreparationProgram", + "Enrollment", + "Finance", + "Graduation", + "Intervention", + "RecruitingAndStaffing", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/stateAbbreviationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -281332,7 +351256,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -281364,15 +351288,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -281399,7 +351314,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -281456,7 +351371,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -282912,6 +352827,62 @@ "fiscalYear" ], "type": "object" + }, + "EdFi_StateEducationAgency_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StateEducationAgency_TrackedChangeKey": { + "properties": { + "stateEducationAgencyId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "stateEducationAgencyId" + ], + "type": "object" + }, + "EdFi_StateEducationAgency_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -283028,7 +352999,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -283071,7 +353042,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -283093,6 +353064,128 @@ "Staff" ] }, + "/ed-fi/stateEducationAgencies/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStateEducationAgenciesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "stateEducationAgencies" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, + "/ed-fi/stateEducationAgencies/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStateEducationAgenciesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StateEducationAgency_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "stateEducationAgencies" + ] + }, + "x-Ed-Fi-domains": [ + "EducationOrganization", + "Staff" + ] + }, "/ed-fi/stateEducationAgencies/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -283128,7 +353221,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -283160,15 +353253,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -283195,7 +353279,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -283252,7 +353336,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -285108,6 +355192,77 @@ "reportCardReference" ], "type": "object" + }, + "EdFi_StudentAcademicRecord_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAcademicRecord_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "schoolYear", + "studentUniqueId", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_StudentAcademicRecord_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -285325,7 +355480,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -285368,7 +355523,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -285393,6 +355548,134 @@ "StudentTranscript" ] }, + "/ed-fi/studentAcademicRecords/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAcademicRecordsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentAcademicRecords" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/studentAcademicRecords/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAcademicRecordsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAcademicRecord_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentAcademicRecords" + ] + }, + "x-Ed-Fi-domains": [ + "Graduation", + "StudentAcademicRecord", + "TeachingAndLearning", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/studentAcademicRecords/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -285428,7 +355711,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -285460,15 +355743,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -285495,7 +355769,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -285552,7 +355826,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -285993,6 +356267,88 @@ "studentAssessmentIdentifier" ], "type": "object" + }, + "EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "educationOrganizationAssociationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentAssessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "educationOrganizationAssociationTypeDescriptor", + "educationOrganizationId", + "namespace", + "studentAssessmentIdentifier", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -286123,7 +356479,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -286166,7 +356522,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -286187,6 +356543,126 @@ "Assessment" ] }, + "/ed-fi/studentAssessmentEducationOrganizationAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentEducationOrganizationAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentAssessmentEducationOrganizationAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, + "/ed-fi/studentAssessmentEducationOrganizationAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentEducationOrganizationAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentEducationOrganizationAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentAssessmentEducationOrganizationAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment" + ] + }, "/ed-fi/studentAssessmentEducationOrganizationAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -286222,7 +356698,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -286254,15 +356730,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -286289,7 +356756,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -286346,7 +356813,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -286788,6 +357255,93 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKey": { + "properties": { + "administrationIdentifier": { + "maxLength": 255, + "type": "string" + }, + "assessmentBatteryPartName": { + "maxLength": 65, + "type": "string" + }, + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "assigningEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "administrationIdentifier", + "assessmentBatteryPartName", + "assessmentIdentifier", + "assigningEducationOrganizationId", + "educationOrganizationId", + "namespace", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -286919,7 +357473,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -286962,7 +357516,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -286983,6 +357537,126 @@ "AssessmentRegistration" ] }, + "/ed-fi/studentAssessmentRegistrationBatteryPartAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentRegistrationBatteryPartAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentAssessmentRegistrationBatteryPartAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/studentAssessmentRegistrationBatteryPartAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentRegistrationBatteryPartAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistrationBatteryPartAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentAssessmentRegistrationBatteryPartAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, "/ed-fi/studentAssessmentRegistrationBatteryPartAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -287018,7 +357692,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -287050,15 +357724,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -287085,7 +357750,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -287142,7 +357807,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -287822,6 +358487,88 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentAssessmentRegistration_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAssessmentRegistration_TrackedChangeKey": { + "properties": { + "administrationIdentifier": { + "maxLength": 255, + "type": "string" + }, + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "assigningEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "administrationIdentifier", + "assessmentIdentifier", + "assigningEducationOrganizationId", + "educationOrganizationId", + "namespace", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentAssessmentRegistration_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -288021,7 +358768,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -288064,7 +358811,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -288085,6 +358832,126 @@ "AssessmentRegistration" ] }, + "/ed-fi/studentAssessmentRegistrations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentRegistrationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentAssessmentRegistrations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/studentAssessmentRegistrations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentRegistrationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessmentRegistration_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentAssessmentRegistrations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, "/ed-fi/studentAssessmentRegistrations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -288120,7 +358987,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -288152,15 +359019,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -288187,7 +359045,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -288244,7 +359102,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -289912,6 +360770,78 @@ "objectiveAssessmentReference" ], "type": "object" + }, + "EdFi_StudentAssessment_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentAssessment_TrackedChangeKey": { + "properties": { + "assessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentAssessmentIdentifier": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "assessmentIdentifier", + "namespace", + "studentAssessmentIdentifier", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentAssessment_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -290158,7 +361088,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -290201,7 +361131,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -290223,6 +361153,128 @@ "StudentAssessment" ] }, + "/ed-fi/studentAssessments/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentAssessments" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, + "/ed-fi/studentAssessments/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentAssessmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentAssessment_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentAssessments" + ] + }, + "x-Ed-Fi-domains": [ + "Assessment", + "StudentAssessment" + ] + }, "/ed-fi/studentAssessments/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -290258,7 +361310,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -290290,15 +361342,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -290325,7 +361368,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -290382,7 +361425,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -291185,6 +362228,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentCteProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCteProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentCteProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -291356,7 +362480,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -291399,7 +362523,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -291420,6 +362544,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentCTEProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCTEProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentCTEProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentCTEProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCTEProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCteProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentCTEProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentCTEProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -291455,7 +362699,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -291487,15 +362731,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -291522,7 +362757,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -291579,7 +362814,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -291857,6 +363092,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StudentCharacteristicDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCharacteristicDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StudentCharacteristicDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -291973,7 +363269,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -292016,7 +363312,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -292040,6 +363336,132 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/studentCharacteristicDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCharacteristicsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "Enrollment", + "RecruitingAndStaffing", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentCharacteristicDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCharacteristicsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCharacteristicDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentCharacteristicDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "Enrollment", + "RecruitingAndStaffing", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/studentCharacteristicDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -292075,7 +363497,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -292107,15 +363529,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -292142,7 +363555,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -292199,7 +363612,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -292622,6 +364035,77 @@ "sectionReference" ], "type": "object" + }, + "EdFi_StudentCohortAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCohortAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "cohortIdentifier": { + "maxLength": 36, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "cohortIdentifier", + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentCohortAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -292731,7 +364215,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -292774,7 +364258,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -292796,6 +364280,128 @@ "StudentCohort" ] }, + "/ed-fi/studentCohortAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCohortAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentCohortAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/studentCohortAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCohortAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCohortAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentCohortAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/studentCohortAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -292831,7 +364437,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -292863,15 +364469,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -292898,7 +364495,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -292955,7 +364552,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -293628,6 +365225,97 @@ "studentSectionAssociationReference" ], "type": "object" + }, + "EdFi_StudentCompetencyObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentCompetencyObjective_TrackedChangeKey": { + "properties": { + "gradingPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "gradingPeriodName": { + "maxLength": 60, + "type": "string" + }, + "gradingPeriodSchoolId": { + "format": "int64", + "type": "integer" + }, + "gradingPeriodSchoolYear": { + "format": "int32", + "type": "integer" + }, + "objective": { + "maxLength": 60, + "type": "string" + }, + "objectiveEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "objectiveGradeLevelDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "gradingPeriodDescriptor", + "gradingPeriodName", + "gradingPeriodSchoolId", + "gradingPeriodSchoolYear", + "objective", + "objectiveEducationOrganizationId", + "objectiveGradeLevelDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentCompetencyObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -293786,7 +365474,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -293829,7 +365517,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -293851,6 +365539,128 @@ "ReportCard" ] }, + "/ed-fi/studentCompetencyObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCompetencyObjectivesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentCompetencyObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, + "/ed-fi/studentCompetencyObjectives/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentCompetencyObjectivesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentCompetencyObjective_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentCompetencyObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "ReportCard" + ] + }, "/ed-fi/studentCompetencyObjectives/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -293886,7 +365696,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -293918,15 +365728,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -293953,7 +365754,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -294010,7 +365811,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -294407,6 +366208,67 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentContactAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentContactAssociation_TrackedChangeKey": { + "properties": { + "contactUniqueId": { + "maxLength": 32, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "contactUniqueId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentContactAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -294546,7 +366408,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -294589,7 +366451,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -294610,6 +366472,126 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/studentContactAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentContactAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentContactAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentContactAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentContactAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentContactAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentContactAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/studentContactAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -294645,7 +366627,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -294677,15 +366659,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -294712,7 +366685,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -294769,7 +366742,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -295970,6 +367943,67 @@ ], "type": "object" }, + "EdFi_StudentDemographic_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentDemographic_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentDemographic_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentDemographic_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDemographic_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDemographic_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_StudentDemographic_TribalAffiliation": { "properties": { "tribalAffiliationDescriptor": { @@ -296124,7 +368158,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -296167,7 +368201,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -296190,6 +368224,130 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/studentDemographics/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDemographicsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDemographic_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentDemographics" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentDemographics/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDemographicsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDemographic_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentDemographics" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/studentDemographics/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -296225,7 +368383,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -296257,15 +368415,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -296292,7 +368441,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -296349,7 +368498,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -297521,6 +369670,67 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "EdFi_StudentDirectory_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentDirectory_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentDirectory_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentDirectory_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDirectory_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDirectory_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -297601,7 +369811,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -297644,7 +369854,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -297666,6 +369876,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/studentDirectories/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDirectoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDirectory_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentDirectories" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentDirectories/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDirectoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDirectory_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentDirectories" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/studentDirectories/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -297701,7 +370033,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -297733,15 +370065,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -297768,7 +370091,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -297825,7 +370148,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -298212,6 +370535,77 @@ ], "type": "object" }, + "EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey": { + "properties": { + "behaviorDescriptor": { + "maxLength": 306, + "type": "string" + }, + "incidentIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "behaviorDescriptor", + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_StudentDisciplineIncidentBehaviorAssociation_Weapon": { "properties": { "weaponDescriptor": { @@ -298333,7 +370727,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -298376,7 +370770,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -298397,6 +370791,126 @@ "Discipline" ] }, + "/ed-fi/studentDisciplineIncidentBehaviorAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentBehaviorAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentDisciplineIncidentBehaviorAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/studentDisciplineIncidentBehaviorAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentBehaviorAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentBehaviorAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentDisciplineIncidentBehaviorAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/studentDisciplineIncidentBehaviorAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -298432,7 +370946,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -298464,15 +370978,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -298499,7 +371004,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -298556,7 +371061,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -298868,6 +371373,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey": { + "properties": { + "incidentIdentifier": { + "maxLength": 36, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "incidentIdentifier", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -298958,7 +371529,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -299001,7 +371572,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -299022,6 +371593,126 @@ "Discipline" ] }, + "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentNonOffenderAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentDisciplineIncidentNonOffenderAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentDisciplineIncidentNonOffenderAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentDisciplineIncidentNonOffenderAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentDisciplineIncidentNonOffenderAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/studentDisciplineIncidentNonOffenderAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -299057,7 +371748,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -299089,15 +371780,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -299124,7 +371806,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -299181,7 +371863,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -299461,6 +372143,67 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -299541,7 +372284,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -299584,7 +372327,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -299605,6 +372348,126 @@ "AssessmentRegistration" ] }, + "/ed-fi/studentEducationOrganizationAssessmentAccommodations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationAssessmentAccommodationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentEducationOrganizationAssessmentAccommodations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, + "/ed-fi/studentEducationOrganizationAssessmentAccommodations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationAssessmentAccommodationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssessmentAccommodation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentEducationOrganizationAssessmentAccommodations" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration" + ] + }, "/ed-fi/studentEducationOrganizationAssessmentAccommodations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -299640,7 +372503,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -299672,15 +372535,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -299707,7 +372561,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -299764,7 +372618,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -300605,6 +373459,67 @@ "indicator" ], "type": "object" + }, + "EdFi_StudentEducationOrganizationAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -300765,7 +373680,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -300808,7 +373723,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -300830,6 +373745,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/studentEducationOrganizationAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentEducationOrganizationAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentEducationOrganizationAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentEducationOrganizationAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/studentEducationOrganizationAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -300865,7 +373902,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -300897,15 +373934,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -300932,7 +373960,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -300989,7 +374017,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -301377,6 +374405,77 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "responsibilityDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "responsibilityDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -301496,7 +374595,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -301539,7 +374638,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -301560,6 +374659,126 @@ "Enrollment" ] }, + "/ed-fi/studentEducationOrganizationResponsibilityAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationResponsibilityAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentEducationOrganizationResponsibilityAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/studentEducationOrganizationResponsibilityAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentEducationOrganizationResponsibilityAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentEducationOrganizationResponsibilityAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentEducationOrganizationResponsibilityAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/studentEducationOrganizationResponsibilityAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -301595,7 +374814,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -301627,15 +374846,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -301662,7 +374872,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -301719,7 +374929,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -302208,6 +375418,73 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentGradebookEntry_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentGradebookEntry_TrackedChangeKey": { + "properties": { + "gradebookEntryIdentifier": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "gradebookEntryIdentifier", + "namespace", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentGradebookEntry_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -302396,7 +375673,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -302439,7 +375716,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -302461,6 +375738,128 @@ "Gradebook" ] }, + "/ed-fi/studentGradebookEntries/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentGradebookEntriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentGradebookEntries" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/studentGradebookEntries/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentGradebookEntriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentGradebookEntry_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentGradebookEntries" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, "/ed-fi/studentGradebookEntries/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -302496,7 +375895,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -302528,15 +375927,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -302563,7 +375953,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -302620,7 +376010,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -303213,6 +376603,67 @@ "immunizationTypeDescriptor" ], "type": "object" + }, + "EdFi_StudentHealth_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentHealth_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentHealth_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -303320,7 +376771,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -303363,7 +376814,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -303384,6 +376835,126 @@ "StudentHealth" ] }, + "/ed-fi/studentHealths/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHealthsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentHealths" + ] + }, + "x-Ed-Fi-domains": [ + "StudentHealth" + ] + }, + "/ed-fi/studentHealths/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHealthsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentHealth_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentHealths" + ] + }, + "x-Ed-Fi-domains": [ + "StudentHealth" + ] + }, "/ed-fi/studentHealths/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -303419,7 +376990,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -303451,15 +377022,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -303486,7 +377048,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -303543,7 +377105,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -304233,6 +377795,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentHomelessProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentHomelessProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentHomelessProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -304404,7 +378047,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -304447,7 +378090,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -304468,6 +378111,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentHomelessProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHomelessProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentHomelessProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentHomelessProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentHomelessProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentHomelessProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentHomelessProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentHomelessProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -304503,7 +378266,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -304535,15 +378298,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -304570,7 +378324,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -304627,7 +378381,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -305165,6 +378919,82 @@ "studentIEPIdentifier" ], "type": "object" + }, + "EdFi_StudentIepGoal_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentIepGoal_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentIepGoal_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "iepFinalizedDate": { + "format": "date", + "type": "string" + }, + "iepGoalIdentifier": { + "maxLength": 120, + "type": "string" + }, + "studentIEPIdentifier": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "iepFinalizedDate", + "iepGoalIdentifier", + "studentIEPIdentifier", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentIepGoal_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIepGoal_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIepGoal_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -305293,7 +379123,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -305336,7 +379166,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -305357,6 +379187,126 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/studentIEPGoals/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIEPGoalsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIepGoal_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentIEPGoals" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, + "/ed-fi/studentIEPGoals/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIEPGoalsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIepGoal_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentIEPGoals" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, "/ed-fi/studentIEPGoals/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -305392,7 +379342,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -305424,15 +379374,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -305459,7 +379400,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -305516,7 +379457,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -306272,6 +380213,92 @@ "studentIEPIdentifier" ], "type": "object" + }, + "EdFi_StudentIepServiceDelivery_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentIepServiceDelivery_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentIepServiceDelivery_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "iepFinalizedDate": { + "format": "date", + "type": "string" + }, + "iepServiceDeliveryIdentifier": { + "maxLength": 120, + "type": "string" + }, + "serviceDeliveryDate": { + "format": "date", + "type": "string" + }, + "serviceDeliveryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentIEPIdentifier": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "iepFinalizedDate", + "iepServiceDeliveryIdentifier", + "serviceDeliveryDate", + "serviceDeliveryDescriptor", + "studentIEPIdentifier", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentIepServiceDelivery_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIepServiceDelivery_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIepServiceDelivery_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -306422,7 +380449,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -306465,7 +380492,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -306486,6 +380513,126 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/studentIEPServiceDeliveries/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIEPServiceDeliveriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIepServiceDelivery_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentIEPServiceDeliveries" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, + "/ed-fi/studentIEPServiceDeliveries/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIEPServiceDeliveriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIepServiceDelivery_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentIEPServiceDeliveries" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, "/ed-fi/studentIEPServiceDeliveries/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -306521,7 +380668,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -306553,15 +380700,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -306588,7 +380726,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -306645,7 +380783,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -307302,6 +381440,87 @@ "staffReference" ], "type": "object" + }, + "EdFi_StudentIepServicePrescription_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentIepServicePrescription_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentIepServicePrescription_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "iepFinalizedDate": { + "format": "date", + "type": "string" + }, + "servicePrescriptionDate": { + "format": "date", + "type": "string" + }, + "servicePrescriptionDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentIEPIdentifier": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "iepFinalizedDate", + "servicePrescriptionDate", + "servicePrescriptionDescriptor", + "studentIEPIdentifier", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentIepServicePrescription_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIepServicePrescription_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIepServicePrescription_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -307485,7 +381704,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -307528,7 +381747,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -307549,6 +381768,126 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/studentIEPServicePrescriptions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIEPServicePrescriptionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIepServicePrescription_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentIEPServicePrescriptions" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, + "/ed-fi/studentIEPServicePrescriptions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIEPServicePrescriptionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIepServicePrescription_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentIEPServicePrescriptions" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, "/ed-fi/studentIEPServicePrescriptions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -307584,7 +381923,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -307616,15 +381955,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -307651,7 +381981,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -307708,7 +382038,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -308586,6 +382916,77 @@ "studentIEPIdentifier" ], "type": "object" + }, + "EdFi_StudentIep_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentIep_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentIep_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "iepFinalizedDate": { + "format": "date", + "type": "string" + }, + "studentIEPIdentifier": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "iepFinalizedDate", + "studentIEPIdentifier", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentIep_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIep_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIep_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -308774,7 +383175,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -308817,7 +383218,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -308838,6 +383239,126 @@ "SpecialEducationDataModel" ] }, + "/ed-fi/studentIEPs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIEPsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIep_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentIEPs" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, + "/ed-fi/studentIEPs/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIEPsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIep_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentIEPs" + ] + }, + "x-Ed-Fi-domains": [ + "SpecialEducationDataModel" + ] + }, "/ed-fi/studentIEPs/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -308873,7 +383394,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -308905,15 +383426,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -308940,7 +383452,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -308997,7 +383509,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -309358,6 +383870,72 @@ "studentIdentificationSystemDescriptor" ], "type": "object" + }, + "EdFi_StudentIdentificationCode_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentIdentificationCode_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "studentIdentificationSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "studentIdentificationSystemDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentIdentificationCode_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationCode_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationCode_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -309466,7 +384044,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -309509,7 +384087,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -309531,6 +384109,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/studentIdentificationCodes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIdentificationCodesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationCode_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentIdentificationCodes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIdentificationCodesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationCode_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentIdentificationCodes" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/studentIdentificationCodes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -309566,7 +384266,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -309598,15 +384298,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -309633,7 +384324,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -309690,7 +384381,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -309917,6 +384608,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_StudentIdentificationSystemDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -310033,7 +384785,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -310076,7 +384828,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -310098,6 +384850,128 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/studentIdentificationSystemDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIdentificationSystemsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/studentIdentificationSystemDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentIdentificationSystemsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentIdentificationSystemDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentIdentificationSystemDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/studentIdentificationSystemDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -310133,7 +385007,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -310165,15 +385039,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -310200,7 +385065,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -310257,7 +385122,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -310743,6 +385608,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentInterventionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentInterventionAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "interventionIdentificationCode": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "interventionIdentificationCode", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentInterventionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -310871,7 +385802,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -310914,7 +385845,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -310936,6 +385867,128 @@ "StudentCohort" ] }, + "/ed-fi/studentInterventionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentInterventionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, + "/ed-fi/studentInterventionAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentInterventionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention", + "StudentCohort" + ] + }, "/ed-fi/studentInterventionAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -310971,7 +386024,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -311003,15 +386056,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -311038,7 +386082,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -311095,7 +386139,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -311515,6 +386559,82 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentInterventionAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "interventionIdentificationCode": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "educationOrganizationId", + "eventDate", + "interventionIdentificationCode", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentInterventionAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -311661,7 +386781,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -311704,7 +386824,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -311725,6 +386845,126 @@ "Intervention" ] }, + "/ed-fi/studentInterventionAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAttendanceEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentInterventionAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, + "/ed-fi/studentInterventionAttendanceEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentInterventionAttendanceEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentInterventionAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentInterventionAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "Intervention" + ] + }, "/ed-fi/studentInterventionAttendanceEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -311760,7 +387000,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -311792,15 +387032,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -311827,7 +387058,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -311884,7 +387115,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -312726,6 +387957,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -312889,7 +388201,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -312932,7 +388244,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -312953,6 +388265,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentLanguageInstructionProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentLanguageInstructionProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentLanguageInstructionProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentLanguageInstructionProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentLanguageInstructionProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentLanguageInstructionProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentLanguageInstructionProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentLanguageInstructionProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -312988,7 +388420,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -313020,15 +388452,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -313055,7 +388478,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -313112,7 +388535,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -313958,6 +389381,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -314184,7 +389688,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -314227,7 +389731,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -314248,6 +389752,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentMigrantEducationProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentMigrantEducationProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentMigrantEducationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentMigrantEducationProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentMigrantEducationProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentMigrantEducationProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentMigrantEducationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentMigrantEducationProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -314283,7 +389907,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -314315,15 +389939,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -314350,7 +389965,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -314407,7 +390022,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -315185,6 +390800,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -315358,7 +391054,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -315401,7 +391097,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -315422,6 +391118,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentNeglectedOrDelinquentProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentNeglectedOrDelinquentProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentNeglectedOrDelinquentProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentNeglectedOrDelinquentProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentNeglectedOrDelinquentProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentNeglectedOrDelinquentProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -315457,7 +391273,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -315489,15 +391305,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -315524,7 +391331,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -315581,7 +391388,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -316095,6 +391902,84 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentPathMilestoneStatus_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentPathMilestoneStatus_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentPathMilestoneStatus_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "pathMilestoneName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + }, + "pathMilestoneTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "pathName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "pathMilestoneName", + "pathMilestoneTypeDescriptor", + "pathName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentPathMilestoneStatus_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentPathMilestoneStatus_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentPathMilestoneStatus_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -316226,7 +392111,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -316269,7 +392154,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -316290,6 +392175,126 @@ "Path" ] }, + "/ed-fi/studentPathMilestoneStatuses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentPathMilestoneStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentPathMilestoneStatus_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentPathMilestoneStatuses" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/studentPathMilestoneStatuses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentPathMilestoneStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentPathMilestoneStatus_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentPathMilestoneStatuses" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/studentPathMilestoneStatuses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -316325,7 +392330,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -316357,15 +392362,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -316392,7 +392388,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -316449,7 +392445,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -316942,6 +392938,79 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentPathPhaseStatus_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentPathPhaseStatus_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentPathPhaseStatus_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "pathName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + }, + "pathPhaseName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "pathName", + "pathPhaseName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentPathPhaseStatus_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentPathPhaseStatus_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentPathPhaseStatus_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -317052,7 +393121,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -317095,7 +393164,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -317116,6 +393185,126 @@ "Path" ] }, + "/ed-fi/studentPathPhaseStatuses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentPathPhaseStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentPathPhaseStatus_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentPathPhaseStatuses" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/studentPathPhaseStatuses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentPathPhaseStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentPathPhaseStatus_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentPathPhaseStatuses" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/studentPathPhaseStatuses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -317151,7 +393340,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -317183,15 +393372,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -317218,7 +393398,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -317275,7 +393455,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -317610,6 +393790,73 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentPath_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentPath_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentPath_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "pathName": { + "maxLength": 60, + "minLength": 0, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "pathName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentPath_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentPath_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentPath_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -317701,7 +393948,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -317744,7 +393991,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -317765,6 +394012,126 @@ "Path" ] }, + "/ed-fi/studentPaths/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentPathsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentPath_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentPaths" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, + "/ed-fi/studentPaths/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentPathsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentPath_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentPaths" + ] + }, + "x-Ed-Fi-domains": [ + "Path" + ] + }, "/ed-fi/studentPaths/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -317800,7 +394167,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -317832,15 +394199,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -317867,7 +394225,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -317924,7 +394282,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -318547,6 +394905,87 @@ "serviceDescriptor" ], "type": "object" + }, + "EdFi_StudentProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -318693,7 +395132,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -318736,7 +395175,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -318763,6 +395202,138 @@ "SectionsAndPrograms" ] }, + "/ed-fi/studentProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/studentProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -318798,7 +395369,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -318830,15 +395401,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -318865,7 +395427,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -318922,7 +395484,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -319427,6 +395989,92 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentProgramAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentProgramAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "educationOrganizationId", + "eventDate", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentProgramAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -319593,7 +396241,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -319636,7 +396284,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -319659,6 +396307,130 @@ "StudentAttendance" ] }, + "/ed-fi/studentProgramAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAttendanceEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentProgramAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentProgramAttendanceEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramAttendanceEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentProgramAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, "/ed-fi/studentProgramAttendanceEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -319694,7 +396466,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -319726,15 +396498,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -319761,7 +396524,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -319818,7 +396581,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -320850,6 +397613,97 @@ "programEvaluationObjectiveReference" ], "type": "object" + }, + "EdFi_StudentProgramEvaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentProgramEvaluation_TrackedChangeKey": { + "properties": { + "evaluationDate": { + "format": "date", + "type": "string" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEvaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programEvaluationTitle": { + "maxLength": 50, + "type": "string" + }, + "programEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "evaluationDate", + "programEducationOrganizationId", + "programEvaluationPeriodDescriptor", + "programEvaluationTitle", + "programEvaluationTypeDescriptor", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentProgramEvaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -321046,7 +397900,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -321089,7 +397943,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -321111,6 +397965,128 @@ "StudentProgramEvaluation" ] }, + "/ed-fi/studentProgramEvaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramEvaluationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentProgramEvaluations" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, + "/ed-fi/studentProgramEvaluations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentProgramEvaluationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentProgramEvaluation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentProgramEvaluations" + ] + }, + "x-Ed-Fi-domains": [ + "TeachingAndLearning", + "StudentProgramEvaluation" + ] + }, "/ed-fi/studentProgramEvaluations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -321146,7 +398122,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -321178,15 +398154,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -321213,7 +398180,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -321270,7 +398237,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -322285,6 +399252,72 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSchoolAssociation_TrackedChangeKey": { + "properties": { + "entryDate": { + "format": "date", + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "entryDate", + "schoolId", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -322581,7 +399614,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -322624,7 +399657,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -322649,6 +399682,134 @@ "SectionsAndPrograms" ] }, + "/ed-fi/studentSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSchoolAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentSchoolAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSchoolAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment", + "Graduation", + "SchoolCalendar", + "TeachingAndLearning", + "SectionsAndPrograms" + ] + }, "/ed-fi/studentSchoolAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -322684,7 +399845,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -322716,15 +399877,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -322751,7 +399903,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -322808,7 +399960,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -323450,6 +400602,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSchoolAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "eventDate", + "schoolId", + "schoolYear", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSchoolAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -323622,7 +400855,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -323665,7 +400898,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -323688,6 +400921,130 @@ "StudentAttendance" ] }, + "/ed-fi/studentSchoolAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAttendanceEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSchoolAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentSchoolAttendanceEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolAttendanceEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSchoolAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, "/ed-fi/studentSchoolAttendanceEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -323723,7 +401080,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -323755,15 +401112,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -323790,7 +401138,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -323847,7 +401195,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -324541,6 +401889,87 @@ "schoolFoodServiceProgramServiceDescriptor" ], "type": "object" + }, + "EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -324695,7 +402124,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -324738,7 +402167,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -324759,6 +402188,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentSchoolFoodServiceProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolFoodServiceProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSchoolFoodServiceProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentSchoolFoodServiceProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSchoolFoodServiceProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSchoolFoodServiceProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSchoolFoodServiceProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentSchoolFoodServiceProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -324794,7 +402343,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -324826,15 +402375,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -324861,7 +402401,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -324918,7 +402458,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -325569,6 +403109,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSection504ProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSection504ProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSection504ProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -325758,7 +403379,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -325801,7 +403422,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -325822,6 +403443,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentSection504ProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSection504ProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSection504ProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentSection504ProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSection504ProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSection504ProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSection504ProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentSection504ProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -325857,7 +403598,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -325889,15 +403630,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -325924,7 +403656,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -325981,7 +403713,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -326688,6 +404420,92 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSectionAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -326905,7 +404723,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -326948,7 +404766,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -326977,6 +404795,142 @@ "SectionsAndPrograms" ] }, + "/ed-fi/studentSectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, + "/ed-fi/studentSectionAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms" + ] + }, "/ed-fi/studentSectionAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -327012,7 +404966,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -327044,15 +404998,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -327079,7 +405024,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -327136,7 +405081,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -327804,6 +405749,97 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSectionAttendanceEvent_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSectionAttendanceEvent_TrackedChangeKey": { + "properties": { + "attendanceEventCategoryDescriptor": { + "maxLength": 306, + "type": "string" + }, + "eventDate": { + "format": "date", + "type": "string" + }, + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "attendanceEventCategoryDescriptor", + "eventDate", + "localCourseCode", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSectionAttendanceEvent_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -327996,7 +406032,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -328039,7 +406075,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -328062,6 +406098,130 @@ "StudentAttendance" ] }, + "/ed-fi/studentSectionAttendanceEvents/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAttendanceEventsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSectionAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, + "/ed-fi/studentSectionAttendanceEvents/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSectionAttendanceEventsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSectionAttendanceEvent_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSectionAttendanceEvents" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation", + "StudentAttendance" + ] + }, "/ed-fi/studentSectionAttendanceEvents/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -328097,7 +406257,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -328129,15 +406289,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -328164,7 +406315,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -328221,7 +406372,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -329565,6 +407716,87 @@ "specialEducationProgramServiceDescriptor" ], "type": "object" + }, + "EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -329860,7 +408092,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -329903,7 +408135,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -329925,6 +408157,128 @@ "SpecialEducation" ] }, + "/ed-fi/studentSpecialEducationProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSpecialEducationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation" + ] + }, + "/ed-fi/studentSpecialEducationProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSpecialEducationProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "SpecialEducation" + ] + }, "/ed-fi/studentSpecialEducationProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -329960,7 +408314,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -329992,15 +408346,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -330027,7 +408372,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -330084,7 +408429,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -330858,6 +409203,87 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey": { + "properties": { + "consentToEvaluationReceivedDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "consentToEvaluationReceivedDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -331111,7 +409537,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -331154,7 +409580,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -331175,6 +409601,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramEligibilityAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentSpecialEducationProgramEligibilityAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentSpecialEducationProgramEligibilityAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentSpecialEducationProgramEligibilityAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentSpecialEducationProgramEligibilityAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentSpecialEducationProgramEligibilityAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -331210,7 +409756,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -331242,15 +409788,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -331277,7 +409814,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -331334,7 +409871,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -332086,6 +410623,87 @@ "titleIPartAProgramServiceDescriptor" ], "type": "object" + }, + "EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -332241,7 +410859,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -332284,7 +410902,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -332305,6 +410923,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/studentTitleIPartAProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTitleIPartAProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentTitleIPartAProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/studentTitleIPartAProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTitleIPartAProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentTitleIPartAProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentTitleIPartAProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/studentTitleIPartAProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -332340,7 +411078,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -332372,15 +411110,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -332407,7 +411136,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -332464,7 +411193,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -332964,6 +411693,67 @@ ], "type": "object" }, + "EdFi_StudentTransportation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_StudentTransportation_TrackedChangeKey": { + "properties": { + "studentUniqueId": { + "maxLength": 32, + "type": "string" + }, + "transportationEducationOrganizationId": { + "format": "int64", + "type": "integer" + } + }, + "required": [ + "studentUniqueId", + "transportationEducationOrganizationId" + ], + "type": "object" + }, + "EdFi_StudentTransportation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "EdFi_StudentTransportation_TravelDayofWeek": { "properties": { "travelDayofWeekDescriptor": { @@ -333096,7 +411886,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -333139,7 +411929,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -333160,6 +411950,126 @@ "Enrollment" ] }, + "/ed-fi/studentTransportations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTransportationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentTransportations" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/studentTransportations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentTransportationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_StudentTransportation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentTransportations" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/studentTransportations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -333195,7 +412105,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -333227,15 +412137,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -333262,7 +412163,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -333319,7 +412220,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -334188,6 +413089,62 @@ "studentUniqueId" ], "type": "object" + }, + "EdFi_Student_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Student_TrackedChangeKey": { + "properties": { + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "studentUniqueId" + ], + "type": "object" + }, + "EdFi_Student_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -334422,7 +413379,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -334465,7 +413422,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -334505,6 +413462,164 @@ "StudentTranscript" ] }, + "/ed-fi/students/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getStudentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "students" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "Enrollment", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, + "/ed-fi/students/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getStudentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Student_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "students" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "Assessment", + "Discipline", + "Enrollment", + "Graduation", + "Intervention", + "SchoolCalendar", + "SpecialEducation", + "StudentAcademicRecord", + "StudentAttendance", + "StudentCohort", + "StudentHealth", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "Gradebook", + "ReportCard", + "SectionsAndPrograms", + "StudentAssessment", + "StudentTranscript" + ] + }, "/ed-fi/students/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -334540,7 +413655,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -334572,15 +413687,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -334607,7 +413713,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -334664,7 +413770,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -334997,6 +414103,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SubmissionStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SubmissionStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SubmissionStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -335113,7 +414280,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -335156,7 +414323,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -335178,6 +414345,128 @@ "Gradebook" ] }, + "/ed-fi/submissionStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSubmissionStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "submissionStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, + "/ed-fi/submissionStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSubmissionStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SubmissionStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "submissionStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "StudentAcademicRecord", + "Gradebook" + ] + }, "/ed-fi/submissionStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -335213,7 +414502,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -335245,15 +414534,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -335280,7 +414560,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -335337,7 +414617,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -335567,6 +414847,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -335683,7 +415024,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -335726,7 +415067,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -335749,6 +415090,130 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/supporterMilitaryConnectionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSupporterMilitaryConnectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "supporterMilitaryConnectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/supporterMilitaryConnectionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSupporterMilitaryConnectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SupporterMilitaryConnectionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "supporterMilitaryConnectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "Enrollment", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/supporterMilitaryConnectionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -335784,7 +415249,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -335816,15 +415281,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -335851,7 +415307,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -335908,7 +415364,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -336137,6 +415593,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SurveyCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SurveyCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -336253,7 +415770,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -336296,7 +415813,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -336317,6 +415834,126 @@ "Survey" ] }, + "/ed-fi/surveyCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -336352,7 +415989,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -336384,15 +416021,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -336419,7 +416047,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -336476,7 +416104,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -336757,6 +416385,78 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_SurveyCourseAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyCourseAssociation_TrackedChangeKey": { + "properties": { + "courseCode": { + "maxLength": 120, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "courseCode", + "educationOrganizationId", + "namespace", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyCourseAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -336858,7 +416558,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -336901,7 +416601,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -336922,6 +416622,126 @@ "Survey" ] }, + "/ed-fi/surveyCourseAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCourseAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyCourseAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyCourseAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyCourseAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyCourseAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyCourseAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyCourseAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -336957,7 +416777,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -336989,15 +416809,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -337024,7 +416835,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -337081,7 +416892,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -337300,6 +417111,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_SurveyLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_SurveyLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -337416,7 +417288,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -337459,7 +417331,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -337480,6 +417352,126 @@ "Survey" ] }, + "/ed-fi/surveyLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyLevelDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -337515,7 +417507,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -337547,15 +417539,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -337582,7 +417565,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -337639,7 +417622,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -337939,6 +417922,83 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_SurveyProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyProgramAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "namespace", + "programName", + "programTypeDescriptor", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -338050,7 +418110,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -338093,7 +418153,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -338114,6 +418174,126 @@ "Survey" ] }, + "/ed-fi/surveyProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyProgramAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -338149,7 +418329,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -338181,15 +418361,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -338216,7 +418387,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -338273,7 +418444,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -338865,6 +419036,78 @@ "surveyQuestionResponseValueIdentifier" ], "type": "object" + }, + "EdFi_SurveyQuestionResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyQuestionResponse_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "questionCode": { + "maxLength": 120, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "namespace", + "questionCode", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyQuestionResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -338983,7 +419226,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -339026,7 +419269,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -339047,6 +419290,126 @@ "Survey" ] }, + "/ed-fi/surveyQuestionResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyQuestionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyQuestionResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestionResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyQuestionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyQuestionResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -339082,7 +419445,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -339114,15 +419477,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -339149,7 +419503,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -339206,7 +419560,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -339752,6 +420106,73 @@ "sortOrder" ], "type": "object" + }, + "EdFi_SurveyQuestion_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyQuestion_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "questionCode": { + "maxLength": 120, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "namespace", + "questionCode", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyQuestion_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -339871,7 +420292,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -339914,7 +420335,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -339935,6 +420356,126 @@ "Survey" ] }, + "/ed-fi/surveyQuestions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyQuestions" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyQuestions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyQuestionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyQuestion_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyQuestions" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyQuestions/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -339970,7 +420511,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -340002,15 +420543,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -340037,7 +420569,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -340094,7 +420626,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -340376,6 +420908,78 @@ "surveyResponseIdentifier" ], "type": "object" + }, + "EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -340477,7 +421081,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -340520,7 +421124,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -340541,6 +421145,126 @@ "Survey" ] }, + "/ed-fi/surveyResponseEducationOrganizationTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseEducationOrganizationTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponseEducationOrganizationTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseEducationOrganizationTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponseEducationOrganizationTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -340576,7 +421300,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -340608,15 +421332,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -340643,7 +421358,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -340700,7 +421415,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -340992,6 +421707,83 @@ "surveyResponseIdentifier" ], "type": "object" + }, + "EdFi_SurveyResponsePersonTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponsePersonTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponsePersonTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "namespace", + "personId", + "sourceSystemDescriptor", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponsePersonTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponsePersonTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponsePersonTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -341103,7 +421895,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -341146,7 +421938,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -341167,6 +421959,126 @@ "Survey" ] }, + "/ed-fi/surveyResponsePersonTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponsePersonTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponsePersonTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponsePersonTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponsePersonTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponsePersonTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponsePersonTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponsePersonTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponsePersonTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -341202,7 +422114,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -341234,15 +422146,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -341269,7 +422172,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -341326,7 +422229,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -341601,6 +422504,78 @@ "surveyResponseIdentifier" ], "type": "object" + }, + "EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "namespace", + "staffUniqueId", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -341702,7 +422677,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -341745,7 +422720,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -341766,6 +422741,126 @@ "Survey" ] }, + "/ed-fi/surveyResponseStaffTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseStaffTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponseStaffTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponseStaffTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponseStaffTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponseStaffTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -341801,7 +422896,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -341833,15 +422928,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -341868,7 +422954,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -341925,7 +423011,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -342445,6 +423531,73 @@ "surveyLevelDescriptor" ], "type": "object" + }, + "EdFi_SurveyResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveyResponse_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "EdFi_SurveyResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -342632,7 +423785,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -342675,7 +423828,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -342696,6 +423849,126 @@ "Survey" ] }, + "/ed-fi/surveyResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveyResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveyResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveyResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveyResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveyResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveyResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -342731,7 +424004,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -342763,15 +424036,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -342798,7 +424062,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -342855,7 +424119,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -343469,6 +424733,137 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionAggregateResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAggregateResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionAggregateResponse_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationDate": { + "format": "date-time", + "type": "string" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationDate", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "namespace", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "surveyIdentifier", + "surveySectionTitle", + "termDescriptor" + ], + "type": "object" + }, + "EdFi_SurveySectionAggregateResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAggregateResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAggregateResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -343693,7 +425088,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -343736,7 +425131,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -343757,6 +425152,126 @@ "PerformanceEvaluation" ] }, + "/ed-fi/surveySectionAggregateResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionAggregateResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionAggregateResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionAggregateResponses" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, + "/ed-fi/surveySectionAggregateResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionAggregateResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionAggregateResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionAggregateResponses" + ] + }, + "x-Ed-Fi-domains": [ + "PerformanceEvaluation" + ] + }, "/ed-fi/surveySectionAggregateResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -343792,7 +425307,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -343824,15 +425339,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -343859,7 +425365,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -343916,7 +425422,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -344324,6 +425830,93 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_SurveySectionAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionAssociation_TrackedChangeKey": { + "properties": { + "localCourseCode": { + "maxLength": 60, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "schoolId": { + "format": "int64", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sectionIdentifier": { + "maxLength": 255, + "type": "string" + }, + "sessionName": { + "maxLength": 120, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "localCourseCode", + "namespace", + "schoolId", + "schoolYear", + "sectionIdentifier", + "sessionName", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_SurveySectionAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -344455,7 +426048,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -344498,7 +426091,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -344519,6 +426112,126 @@ "Survey" ] }, + "/ed-fi/surveySectionAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -344554,7 +426267,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -344586,15 +426299,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -344621,7 +426325,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -344678,7 +426382,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -344999,6 +426703,83 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -345110,7 +426891,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -345153,7 +426934,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -345174,6 +426955,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseEducationOrganizationTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseEducationOrganizationTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseEducationOrganizationTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponseEducationOrganizationTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponseEducationOrganizationTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -345209,7 +427110,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -345241,15 +427142,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -345276,7 +427168,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -345333,7 +427225,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -345661,6 +427553,88 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponsePersonTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponsePersonTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponsePersonTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "personId", + "sourceSystemDescriptor", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponsePersonTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponsePersonTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponsePersonTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -345782,7 +427756,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -345825,7 +427799,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -345846,6 +427820,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponsePersonTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponsePersonTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponsePersonTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponsePersonTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponsePersonTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponsePersonTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponsePersonTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponsePersonTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponsePersonTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -345881,7 +427975,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -345913,15 +428007,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -345948,7 +428033,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -346005,7 +428090,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -346316,6 +428401,83 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "staffUniqueId": { + "maxLength": 32, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "staffUniqueId", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -346427,7 +428589,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -346470,7 +428632,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -346491,6 +428653,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponseStaffTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseStaffTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponseStaffTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponseStaffTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponseStaffTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponseStaffTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponseStaffTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -346526,7 +428808,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -346558,15 +428840,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -346593,7 +428866,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -346650,7 +428923,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -346984,6 +429257,78 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySectionResponse_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySectionResponse_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySectionResponse_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -347094,7 +429439,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -347137,7 +429482,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -347158,6 +429503,126 @@ "Survey" ] }, + "/ed-fi/surveySectionResponses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponsesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySectionResponses/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionResponsesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySectionResponse_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponses" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySectionResponses/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -347193,7 +429658,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -347225,15 +429690,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -347260,7 +429716,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -347317,7 +429773,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -347690,6 +430146,73 @@ "surveySectionTitle" ], "type": "object" + }, + "EdFi_SurveySection_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_SurveySection_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "EdFi_SurveySection_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -347875,7 +430398,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -347918,7 +430441,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -347939,6 +430462,126 @@ "Survey" ] }, + "/ed-fi/surveySections/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySections" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveySections/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveySectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_SurveySection_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySections" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveySections/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -347974,7 +430617,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -348006,15 +430649,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -348041,7 +430675,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -348098,7 +430732,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -348539,6 +431173,68 @@ "surveyIdentifier" ], "type": "object" + }, + "EdFi_Survey_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_Survey_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "namespace", + "surveyIdentifier" + ], + "type": "object" + }, + "EdFi_Survey_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -348686,7 +431382,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -348729,7 +431425,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -348750,6 +431446,126 @@ "Survey" ] }, + "/ed-fi/surveys/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getSurveysDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveys" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, + "/ed-fi/surveys/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getSurveysKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_Survey_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveys" + ] + }, + "x-Ed-Fi-domains": [ + "Survey" + ] + }, "/ed-fi/surveys/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -348785,7 +431601,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -348817,15 +431633,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -348852,7 +431659,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -348909,7 +431716,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -349155,6 +431962,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TeachingCredentialBasisDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -349271,7 +432139,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -349314,7 +432182,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -349336,6 +432204,128 @@ "Staff" ] }, + "/ed-fi/teachingCredentialBasisDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialBasesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "teachingCredentialBasisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, + "/ed-fi/teachingCredentialBasisDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialBasesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialBasisDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "teachingCredentialBasisDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, "/ed-fi/teachingCredentialBasisDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -349371,7 +432361,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -349403,15 +432393,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -349438,7 +432419,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -349495,7 +432476,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -349724,6 +432705,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TeachingCredentialDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TeachingCredentialDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TeachingCredentialDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -349840,7 +432882,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -349883,7 +432925,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -349905,6 +432947,128 @@ "Staff" ] }, + "/ed-fi/teachingCredentialDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "teachingCredentialDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, + "/ed-fi/teachingCredentialDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTeachingCredentialsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TeachingCredentialDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "teachingCredentialDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Credential", + "Staff" + ] + }, "/ed-fi/teachingCredentialDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -349940,7 +433104,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -349972,15 +433136,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -350007,7 +433162,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -350064,7 +433219,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -350292,6 +433447,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -350408,7 +433624,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -350451,7 +433667,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -350472,6 +433688,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/technicalSkillsAssessmentDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTechnicalSkillsAssessmentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "technicalSkillsAssessmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/technicalSkillsAssessmentDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTechnicalSkillsAssessmentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TechnicalSkillsAssessmentDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "technicalSkillsAssessmentDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/technicalSkillsAssessmentDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -350507,7 +433843,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -350539,15 +433875,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -350574,7 +433901,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -350631,7 +433958,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -350863,6 +434190,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TelephoneNumberTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -350979,7 +434367,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -351022,7 +434410,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -351048,6 +434436,136 @@ "Survey" ] }, + "/ed-fi/telephoneNumberTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTelephoneNumberTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "telephoneNumberTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "Staff", + "StudentIdentificationAndDemographics", + "Survey" + ] + }, + "/ed-fi/telephoneNumberTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTelephoneNumberTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TelephoneNumberTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "telephoneNumberTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "Staff", + "StudentIdentificationAndDemographics", + "Survey" + ] + }, "/ed-fi/telephoneNumberTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -351083,7 +434601,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -351115,15 +434633,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -351150,7 +434659,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -351207,7 +434716,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -351454,6 +434963,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TermDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TermDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TermDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -351570,7 +435140,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -351613,7 +435183,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -351649,6 +435219,156 @@ "StudentTranscript" ] }, + "/ed-fi/termDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTermsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "termDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "EducatorPreparationProgram", + "Enrollment", + "Graduation", + "PerformanceEvaluation", + "RecruitingAndStaffing", + "SchoolCalendar", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, + "/ed-fi/termDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTermsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TermDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "termDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "BellSchedule", + "EducatorPreparationProgram", + "Enrollment", + "Graduation", + "PerformanceEvaluation", + "RecruitingAndStaffing", + "SchoolCalendar", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "StudentIdentificationAndDemographics", + "Survey", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms", + "StudentTranscript" + ] + }, "/ed-fi/termDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -351684,7 +435404,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -351716,15 +435436,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -351751,7 +435462,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -351808,7 +435519,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -352050,6 +435761,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TitleIPartAParticipantDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -352166,7 +435938,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -352209,7 +435981,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -352230,6 +436002,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/titleIPartAParticipantDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAParticipantsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "titleIPartAParticipantDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/titleIPartAParticipantDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAParticipantsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAParticipantDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "titleIPartAParticipantDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/titleIPartAParticipantDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -352265,7 +436157,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -352297,15 +436189,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -352332,7 +436215,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -352389,7 +436272,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -352616,6 +436499,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -352732,7 +436676,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -352775,7 +436719,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -352796,6 +436740,126 @@ "AlternativeAndSupplementalServices" ] }, + "/ed-fi/titleIPartAProgramServiceDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAProgramServicesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "titleIPartAProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, + "/ed-fi/titleIPartAProgramServiceDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartAProgramServicesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartAProgramServiceDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "titleIPartAProgramServiceDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices" + ] + }, "/ed-fi/titleIPartAProgramServiceDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -352831,7 +436895,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -352863,15 +436927,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -352898,7 +436953,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -352955,7 +437010,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -353195,6 +437250,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -353311,7 +437427,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -353354,7 +437470,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -353388,6 +437504,152 @@ "SectionsAndPrograms" ] }, + "/ed-fi/titleIPartASchoolDesignationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartASchoolDesignationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "titleIPartASchoolDesignationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, + "/ed-fi/titleIPartASchoolDesignationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTitleIPartASchoolDesignationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TitleIPartASchoolDesignationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "titleIPartASchoolDesignationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AlternativeAndSupplementalServices", + "BellSchedule", + "Discipline", + "EducationOrganization", + "Enrollment", + "Graduation", + "SchoolCalendar", + "SpecialEducation", + "Staff", + "StudentAcademicRecord", + "StudentAttendance", + "TeachingAndLearning", + "CourseCatalog", + "SectionsAndPrograms" + ] + }, "/ed-fi/titleIPartASchoolDesignationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -353423,7 +437685,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -353455,15 +437717,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -353490,7 +437743,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -353547,7 +437800,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -353787,6 +438040,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -353903,7 +438217,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -353946,7 +438260,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -353967,6 +438281,126 @@ "Enrollment" ] }, + "/ed-fi/transportationPublicExpenseEligibilityTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTransportationPublicExpenseEligibilityTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "transportationPublicExpenseEligibilityTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/transportationPublicExpenseEligibilityTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTransportationPublicExpenseEligibilityTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TransportationPublicExpenseEligibilityTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "transportationPublicExpenseEligibilityTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/transportationPublicExpenseEligibilityTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -354002,7 +438436,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -354034,15 +438468,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -354069,7 +438494,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -354126,7 +438551,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -354353,6 +438778,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TransportationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TransportationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TransportationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -354469,7 +438955,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -354512,7 +438998,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -354533,6 +439019,126 @@ "Enrollment" ] }, + "/ed-fi/transportationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTransportationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "transportationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/transportationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTransportationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TransportationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "transportationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/transportationTypeDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -354568,7 +439174,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -354600,15 +439206,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -354635,7 +439232,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -354692,7 +439289,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -354919,6 +439516,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TravelDayofWeekDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TravelDayofWeekDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TravelDayofWeekDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -355035,7 +439693,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -355078,7 +439736,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -355099,6 +439757,126 @@ "Enrollment" ] }, + "/ed-fi/travelDayofWeekDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTravelDayofWeeksDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "travelDayofWeekDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/travelDayofWeekDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTravelDayofWeeksKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TravelDayofWeekDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "travelDayofWeekDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/travelDayofWeekDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -355134,7 +439912,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -355166,15 +439944,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -355201,7 +439970,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -355258,7 +440027,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -355485,6 +440254,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TravelDirectionDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TravelDirectionDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TravelDirectionDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -355601,7 +440431,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -355644,7 +440474,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -355665,6 +440495,126 @@ "Enrollment" ] }, + "/ed-fi/travelDirectionDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTravelDirectionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "travelDirectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, + "/ed-fi/travelDirectionDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTravelDirectionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TravelDirectionDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "travelDirectionDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Enrollment" + ] + }, "/ed-fi/travelDirectionDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -355700,7 +440650,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -355732,15 +440682,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -355767,7 +440708,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -355824,7 +440765,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -356054,6 +440995,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_TribalAffiliationDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_TribalAffiliationDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_TribalAffiliationDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -356170,7 +441172,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -356213,7 +441215,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -356237,6 +441239,132 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/tribalAffiliationDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getTribalAffiliationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "tribalAffiliationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "Enrollment", + "Staff", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/tribalAffiliationDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getTribalAffiliationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_TribalAffiliationDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "tribalAffiliationDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "Enrollment", + "Staff", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/tribalAffiliationDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -356272,7 +441400,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -356304,15 +441432,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -356339,7 +441458,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -356396,7 +441515,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -356631,6 +441750,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_VisaDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_VisaDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_VisaDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -356747,7 +441927,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -356790,7 +441970,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -356816,6 +441996,136 @@ "StudentIdentificationAndDemographics" ] }, + "/ed-fi/visaDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getVisasDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "visaDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "Staff", + "StudentIdentificationAndDemographics" + ] + }, + "/ed-fi/visaDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getVisasKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_VisaDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "visaDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "AssessmentRegistration", + "EducatorPreparationProgram", + "Enrollment", + "RecruitingAndStaffing", + "Staff", + "StudentIdentificationAndDemographics" + ] + }, "/ed-fi/visaDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -356851,7 +442161,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -356883,15 +442193,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -356918,7 +442219,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -356975,7 +442276,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -357207,6 +442508,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_WeaponDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_WeaponDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_WeaponDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -357323,7 +442685,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -357366,7 +442728,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -357387,6 +442749,126 @@ "Discipline" ] }, + "/ed-fi/weaponDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getWeaponsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "weaponDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, + "/ed-fi/weaponDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getWeaponsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_WeaponDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "weaponDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "Discipline" + ] + }, "/ed-fi/weaponDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -357422,7 +442904,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -357454,15 +442936,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -357489,7 +442962,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -357546,7 +443019,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -357773,6 +443246,67 @@ "shortDescription" ], "type": "object" + }, + "EdFi_WithdrawReasonDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/EdFi_WithdrawReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "EdFi_WithdrawReasonDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "EdFi_WithdrawReasonDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/EdFi_WithdrawReasonDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/EdFi_WithdrawReasonDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -357889,7 +443423,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -357932,7 +443466,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -357953,6 +443487,126 @@ "RecruitingAndStaffing" ] }, + "/ed-fi/withdrawReasonDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "getWithdrawReasonsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_WithdrawReasonDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "withdrawReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, + "/ed-fi/withdrawReasonDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "getWithdrawReasonsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/EdFi_WithdrawReasonDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "withdrawReasonDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + "RecruitingAndStaffing" + ] + }, "/ed-fi/withdrawReasonDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -357988,7 +443642,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -358020,15 +443674,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -358055,7 +443700,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -358112,7 +443757,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" diff --git a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.1-homograph-api-schema-authoritative.json b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.1-homograph-api-schema-authoritative.json index d971f4576..060989a41 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.1-homograph-api-schema-authoritative.json +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.1-homograph-api-schema-authoritative.json @@ -351,6 +351,69 @@ "studentSchoolAssociationReference" ], "type": "object" + }, + "Homograph_Contact_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_Contact_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_Contact_TrackedChangeKey": { + "properties": { + "contactFirstName": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "contactLastSurname": { + "maxLength": 75, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "contactFirstName", + "contactLastSurname" + ], + "type": "object" + }, + "Homograph_Contact_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_Contact_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_Contact_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -433,7 +496,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -476,7 +539,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -496,6 +559,124 @@ "x-Ed-Fi-domains": [ ] }, + "/homograph/contacts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographContactsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Contact_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "contacts" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/contacts/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographContactsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Contact_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "contacts" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/homograph/contacts/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -531,7 +712,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -563,15 +744,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -598,7 +770,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -655,7 +827,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -850,6 +1022,69 @@ "lastSurname" ], "type": "object" + }, + "Homograph_Name_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_Name_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_Name_TrackedChangeKey": { + "properties": { + "firstName": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "lastSurname": { + "maxLength": 75, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "firstName", + "lastSurname" + ], + "type": "object" + }, + "Homograph_Name_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_Name_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_Name_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -932,7 +1167,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -975,7 +1210,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -995,27 +1230,40 @@ "x-Ed-Fi-domains": [ ] }, - "/homograph/names/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_HomographNamesById", + "/homograph/names/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographNamesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Name_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -1029,48 +1277,144 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "names" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/names/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_HomographNamesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographNamesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Name_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "names" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/names/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_HomographNamesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "names" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_HomographNamesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" } + }, + { + "$ref": "#/components/parameters/If-None-Match" } ], "responses": { @@ -1097,7 +1441,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1154,7 +1498,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1309,6 +1653,62 @@ "schoolYear" ], "type": "object" + }, + "Homograph_SchoolYearType_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_SchoolYearType_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_SchoolYearType_TrackedChangeKey": { + "properties": { + "schoolYear": { + "maxLength": 20, + "type": "string" + } + }, + "required": [ + "schoolYear" + ], + "type": "object" + }, + "Homograph_SchoolYearType_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_SchoolYearType_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_SchoolYearType_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -1379,7 +1779,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1422,7 +1822,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1442,6 +1842,124 @@ "x-Ed-Fi-domains": [ ] }, + "/homograph/schoolYearTypes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographSchoolYearTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_SchoolYearType_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolYearTypes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/schoolYearTypes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographSchoolYearTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_SchoolYearType_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolYearTypes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/homograph/schoolYearTypes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -1477,7 +1995,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1509,15 +2027,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -1544,7 +2053,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1601,7 +2110,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1825,6 +2334,62 @@ "schoolName" ], "type": "object" + }, + "Homograph_School_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_School_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_School_TrackedChangeKey": { + "properties": { + "schoolName": { + "maxLength": 100, + "type": "string" + } + }, + "required": [ + "schoolName" + ], + "type": "object" + }, + "Homograph_School_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_School_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_School_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -1905,7 +2470,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1948,7 +2513,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1968,6 +2533,124 @@ "x-Ed-Fi-domains": [ ] }, + "/homograph/schools/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographSchoolsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_School_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schools" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/schools/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographSchoolsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_School_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schools" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/homograph/schools/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -2003,7 +2686,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2035,15 +2718,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -2070,7 +2744,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2127,7 +2801,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2465,6 +3139,69 @@ "studentSchoolAssociationReference" ], "type": "object" + }, + "Homograph_Staff_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_Staff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_Staff_TrackedChangeKey": { + "properties": { + "staffFirstName": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "staffLastSurname": { + "maxLength": 75, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "staffFirstName", + "staffLastSurname" + ], + "type": "object" + }, + "Homograph_Staff_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_Staff_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_Staff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -2547,7 +3284,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2590,7 +3327,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2610,6 +3347,124 @@ "x-Ed-Fi-domains": [ ] }, + "/homograph/staffs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStaffsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Staff_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffs" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/staffs/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStaffsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Staff_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffs" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/homograph/staffs/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -2645,7 +3500,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2677,15 +3532,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -2712,7 +3558,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2769,7 +3615,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3012,6 +3858,74 @@ "studentLastSurname" ], "type": "object" + }, + "Homograph_StudentSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_StudentSchoolAssociation_TrackedChangeKey": { + "properties": { + "schoolName": { + "maxLength": 100, + "type": "string" + }, + "studentFirstName": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "studentLastSurname": { + "maxLength": 75, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "schoolName", + "studentFirstName", + "studentLastSurname" + ], + "type": "object" + }, + "Homograph_StudentSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3045,36 +3959,147 @@ } }, { - "description": "The name of the school.", - "in": "query", - "name": "schoolName", - "schema": { - "maxLength": 100, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "description": "The name of the school.", + "in": "query", + "name": "schoolName", + "schema": { + "maxLength": 100, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "in": "query", + "name": "studentFirstName", + "schema": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "The name borne in common by members of a family.", + "in": "query", + "name": "studentLastSurname", + "schema": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "studentSchoolAssociations" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_HomographStudentSchoolAssociation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation" + } + } + }, + "description": "The JSON representation of the StudentSchoolAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSchoolAssociation" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "studentSchoolAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/studentSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStudentSchoolAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", - "in": "query", - "name": "studentFirstName", - "schema": { - "maxLength": 75, - "minLength": 1, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "$ref": "#/components/parameters/limit" }, { - "description": "The name borne in common by members of a family.", - "in": "query", - "name": "studentLastSurname", - "schema": { - "maxLength": 75, - "minLength": 1, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -3083,16 +4108,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation" + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3104,38 +4126,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSchoolAssociations" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_HomographStudentSchoolAssociation", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/studentSchoolAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStudentSchoolAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the StudentSchoolAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSchoolAssociation" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3146,20 +4184,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSchoolAssociations" ] @@ -3202,7 +4234,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3234,15 +4266,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -3269,7 +4292,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3326,7 +4349,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3604,6 +4627,69 @@ "studentLastSurname" ], "type": "object" + }, + "Homograph_Student_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_Student_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_Student_TrackedChangeKey": { + "properties": { + "studentFirstName": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "studentLastSurname": { + "maxLength": 75, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "studentFirstName", + "studentLastSurname" + ], + "type": "object" + }, + "Homograph_Student_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_Student_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_Student_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3696,7 +4782,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3739,7 +4825,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3759,6 +4845,124 @@ "x-Ed-Fi-domains": [ ] }, + "/homograph/students/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStudentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Student_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "students" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/students/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStudentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Student_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "students" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/homograph/students/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -3794,7 +4998,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3826,15 +5030,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -3861,7 +5056,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3918,7 +5113,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" diff --git a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.1-sample-api-schema-authoritative.json b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.1-sample-api-schema-authoritative.json index f2c041ff3..ee6cb10ad 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.1-sample-api-schema-authoritative.json +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.1-sample-api-schema-authoritative.json @@ -211,6 +211,67 @@ "shortDescription" ], "type": "object" + }, + "Sample_ArtMediumDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_ArtMediumDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_ArtMediumDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Sample_ArtMediumDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_ArtMediumDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_ArtMediumDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -327,7 +388,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -370,7 +431,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -390,6 +451,124 @@ "x-Ed-Fi-domains": [ ] }, + "/sample/artMediumDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleArtMediaDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_ArtMediumDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "artMediumDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/artMediumDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleArtMediaKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_ArtMediumDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "artMediumDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/sample/artMediumDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -425,7 +604,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -457,15 +636,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -492,7 +662,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -549,7 +719,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1436,6 +1606,67 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "Sample_BusRoute_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_BusRoute_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_BusRoute_TrackedChangeKey": { + "properties": { + "busId": { + "maxLength": 120, + "type": "string" + }, + "busRouteNumber": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "busId", + "busRouteNumber" + ], + "type": "object" + }, + "Sample_BusRoute_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_BusRoute_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_BusRoute_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -1645,7 +1876,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1688,7 +1919,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1708,27 +1939,40 @@ "x-Ed-Fi-domains": [ ] }, - "/sample/busRoutes/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_SampleBusRoutesById", + "/sample/busRoutes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleBusRoutesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_BusRoute_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -1742,48 +1986,144 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "busRoutes" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/busRoutes/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_SampleBusRoutesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleBusRoutesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_BusRoute_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "busRoutes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/busRoutes/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_SampleBusRoutesById", + "parameters": [ { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, "schema": { - "default": false, - "type": "boolean" + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "busRoutes" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_SampleBusRoutesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" } + }, + { + "$ref": "#/components/parameters/If-None-Match" } ], "responses": { @@ -1810,7 +2150,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1867,7 +2207,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2106,6 +2446,62 @@ "busId" ], "type": "object" + }, + "Sample_Bus_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_Bus_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_Bus_TrackedChangeKey": { + "properties": { + "busId": { + "maxLength": 120, + "type": "string" + } + }, + "required": [ + "busId" + ], + "type": "object" + }, + "Sample_Bus_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_Bus_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_Bus_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -2176,7 +2572,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2219,7 +2615,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2239,27 +2635,40 @@ "x-Ed-Fi-domains": [ ] }, - "/sample/buses/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_SampleBusesById", + "/sample/buses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleBusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_Bus_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2273,48 +2682,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "buses" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/buses/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_SampleBusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleBusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -2322,14 +2720,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Sample_Bus" + "items": { + "$ref": "#/components/schemas/Sample_Bus_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2341,20 +2739,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "buses" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "put_SampleBus", + "x-Ed-Fi-domains": [ + ] + }, + "/sample/buses/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_SampleBusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -2369,18 +2771,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Sample_Bus" - } - } - }, - "description": "The JSON representation of the Bus resource to be created or updated.", - "required": true, - "x-bodyName": "Bus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -2398,7 +2788,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2410,7 +2800,122 @@ "$ref": "#/components/responses/Error" } }, - "summary": "Updates a resource based on the resource identifier.", + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "buses" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_SampleBusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Sample_Bus" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "buses" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "put_SampleBus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Sample_Bus" + } + } + }, + "description": "The JSON representation of the Bus resource to be created or updated.", + "required": true, + "x-bodyName": "Bus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Updates a resource based on the resource identifier.", "tags": [ "buses" ] @@ -3668,6 +4173,67 @@ "shortDescription" ], "type": "object" + }, + "Sample_FavoriteBookCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_FavoriteBookCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_FavoriteBookCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Sample_FavoriteBookCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_FavoriteBookCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_FavoriteBookCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3784,7 +4350,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3827,7 +4393,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3847,6 +4413,124 @@ "x-Ed-Fi-domains": [ ] }, + "/sample/favoriteBookCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleFavoriteBookCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_FavoriteBookCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "favoriteBookCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/favoriteBookCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleFavoriteBookCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_FavoriteBookCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "favoriteBookCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/sample/favoriteBookCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -3882,7 +4566,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3914,15 +4598,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -3949,7 +4624,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4006,7 +4681,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4233,6 +4908,67 @@ "shortDescription" ], "type": "object" + }, + "Sample_MembershipTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_MembershipTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Sample_MembershipTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -4313,13 +5049,124 @@ "x-Ed-Fi-isIdentity": true }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "membershipTypeDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_SampleMembershipType", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor" + } + } + }, + "description": "The JSON representation of the MembershipType resource to be created or updated.", + "required": true, + "x-bodyName": "MembershipType" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "membershipTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/membershipTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleMembershipTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -4328,16 +5175,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor" + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4349,38 +5193,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "membershipTypeDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_SampleMembershipType", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/sample/membershipTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleMembershipTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the MembershipType resource to be created or updated.", - "required": true, - "x-bodyName": "MembershipType" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4391,20 +5251,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "membershipTypeDescriptors" ] @@ -4447,7 +5301,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4479,15 +5333,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -4514,7 +5359,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4571,7 +5416,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6225,6 +7070,87 @@ "style" ], "type": "object" + }, + "Sample_StudentArtProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_StudentArtProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "Sample_StudentArtProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -6424,21 +7350,132 @@ } }, { - "description": "The reason the student left the program within a school or district.", - "in": "query", - "name": "reasonExitedDescriptor", - "schema": { - "maxLength": 306, - "type": "string" - } + "description": "The reason the student left the program within a school or district.", + "in": "query", + "name": "reasonExitedDescriptor", + "schema": { + "maxLength": 306, + "type": "string" + } + }, + { + "description": "Indicates whether the student received services during the summer session or between sessions.", + "in": "query", + "name": "servedOutsideOfRegularSession", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "studentArtProgramAssociations" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_SampleStudentArtProgramAssociation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentArtProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentArtProgramAssociation" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "studentArtProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/studentArtProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleStudentArtProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" }, { - "description": "Indicates whether the student received services during the summer session or between sessions.", - "in": "query", - "name": "servedOutsideOfRegularSession", - "schema": { - "type": "boolean" - } + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -6447,16 +7484,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation" + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6468,38 +7502,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentArtProgramAssociations" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_SampleStudentArtProgramAssociation", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/sample/studentArtProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleStudentArtProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the StudentArtProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentArtProgramAssociation" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6510,20 +7560,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentArtProgramAssociations" ] @@ -6566,7 +7610,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6598,15 +7642,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -6633,7 +7668,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6690,7 +7725,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9208,6 +10243,77 @@ ], "type": "object" }, + "Sample_StudentGraduationPlanAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_StudentGraduationPlanAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_StudentGraduationPlanAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "graduationPlanTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "graduationSchoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "graduationPlanTypeDescriptor", + "graduationSchoolYear", + "studentUniqueId" + ], + "type": "object" + }, + "Sample_StudentGraduationPlanAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_StudentGraduationPlanAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_StudentGraduationPlanAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "Sample_StudentGraduationPlanAssociation_YearsAttended": { "properties": { "yearsAttended": { @@ -9400,7 +10506,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9443,7 +10549,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9463,6 +10569,124 @@ "x-Ed-Fi-domains": [ ] }, + "/sample/studentGraduationPlanAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleStudentGraduationPlanAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_StudentGraduationPlanAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentGraduationPlanAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/studentGraduationPlanAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleStudentGraduationPlanAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_StudentGraduationPlanAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentGraduationPlanAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/sample/studentGraduationPlanAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -9498,7 +10722,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9530,15 +10754,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -9565,7 +10780,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9622,7 +10837,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" diff --git a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/homograph-api-schema-authoritative.json b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/homograph-api-schema-authoritative.json index fa66c1e8c..cb83c363f 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/homograph-api-schema-authoritative.json +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/homograph-api-schema-authoritative.json @@ -350,6 +350,69 @@ "studentSchoolAssociationReference" ], "type": "object" + }, + "Homograph_Contact_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_Contact_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_Contact_TrackedChangeKey": { + "properties": { + "contactFirstName": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "contactLastSurname": { + "maxLength": 75, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "contactFirstName", + "contactLastSurname" + ], + "type": "object" + }, + "Homograph_Contact_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_Contact_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_Contact_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -432,7 +495,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -475,7 +538,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -495,6 +558,124 @@ "x-Ed-Fi-domains": [ ] }, + "/homograph/contacts/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographContactsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Contact_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "contacts" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/contacts/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographContactsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Contact_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "contacts" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/homograph/contacts/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -530,7 +711,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -562,15 +743,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -597,7 +769,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -654,7 +826,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -849,6 +1021,69 @@ "lastSurname" ], "type": "object" + }, + "Homograph_Name_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_Name_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_Name_TrackedChangeKey": { + "properties": { + "firstName": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "lastSurname": { + "maxLength": 75, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "firstName", + "lastSurname" + ], + "type": "object" + }, + "Homograph_Name_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_Name_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_Name_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -931,7 +1166,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -974,7 +1209,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -994,27 +1229,40 @@ "x-Ed-Fi-domains": [ ] }, - "/homograph/names/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_HomographNamesById", + "/homograph/names/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographNamesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Name_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -1028,48 +1276,144 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "names" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/names/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_HomographNamesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographNamesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Name_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "names" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/names/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_HomographNamesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "names" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_HomographNamesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" } + }, + { + "$ref": "#/components/parameters/If-None-Match" } ], "responses": { @@ -1096,7 +1440,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1153,7 +1497,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1308,6 +1652,62 @@ "schoolYear" ], "type": "object" + }, + "Homograph_SchoolYearType_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_SchoolYearType_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_SchoolYearType_TrackedChangeKey": { + "properties": { + "schoolYear": { + "maxLength": 20, + "type": "string" + } + }, + "required": [ + "schoolYear" + ], + "type": "object" + }, + "Homograph_SchoolYearType_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_SchoolYearType_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_SchoolYearType_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -1378,7 +1778,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1421,7 +1821,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1441,6 +1841,124 @@ "x-Ed-Fi-domains": [ ] }, + "/homograph/schoolYearTypes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographSchoolYearTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_SchoolYearType_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schoolYearTypes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/schoolYearTypes/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographSchoolYearTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_SchoolYearType_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schoolYearTypes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/homograph/schoolYearTypes/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -1476,7 +1994,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1508,15 +2026,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -1543,7 +2052,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1600,7 +2109,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1824,6 +2333,62 @@ "schoolName" ], "type": "object" + }, + "Homograph_School_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_School_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_School_TrackedChangeKey": { + "properties": { + "schoolName": { + "maxLength": 100, + "type": "string" + } + }, + "required": [ + "schoolName" + ], + "type": "object" + }, + "Homograph_School_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_School_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_School_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -1904,7 +2469,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1947,7 +2512,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1967,6 +2532,124 @@ "x-Ed-Fi-domains": [ ] }, + "/homograph/schools/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographSchoolsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_School_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "schools" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/schools/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographSchoolsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_School_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "schools" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/homograph/schools/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -2002,7 +2685,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2034,15 +2717,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -2069,7 +2743,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2126,7 +2800,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2464,6 +3138,69 @@ "studentSchoolAssociationReference" ], "type": "object" + }, + "Homograph_Staff_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_Staff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_Staff_TrackedChangeKey": { + "properties": { + "staffFirstName": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "staffLastSurname": { + "maxLength": 75, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "staffFirstName", + "staffLastSurname" + ], + "type": "object" + }, + "Homograph_Staff_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_Staff_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_Staff_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -2546,7 +3283,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2589,7 +3326,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2609,6 +3346,124 @@ "x-Ed-Fi-domains": [ ] }, + "/homograph/staffs/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStaffsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Staff_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "staffs" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/staffs/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStaffsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Staff_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "staffs" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/homograph/staffs/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -2644,7 +3499,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2676,15 +3531,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -2711,7 +3557,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2768,7 +3614,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3011,6 +3857,74 @@ "studentLastSurname" ], "type": "object" + }, + "Homograph_StudentSchoolAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_StudentSchoolAssociation_TrackedChangeKey": { + "properties": { + "schoolName": { + "maxLength": 100, + "type": "string" + }, + "studentFirstName": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "studentLastSurname": { + "maxLength": 75, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "schoolName", + "studentFirstName", + "studentLastSurname" + ], + "type": "object" + }, + "Homograph_StudentSchoolAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3044,36 +3958,147 @@ } }, { - "description": "The name of the school.", - "in": "query", - "name": "schoolName", - "schema": { - "maxLength": 100, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "description": "The name of the school.", + "in": "query", + "name": "schoolName", + "schema": { + "maxLength": 100, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", + "in": "query", + "name": "studentFirstName", + "schema": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "The name borne in common by members of a family.", + "in": "query", + "name": "studentLastSurname", + "schema": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "studentSchoolAssociations" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_HomographStudentSchoolAssociation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation" + } + } + }, + "description": "The JSON representation of the StudentSchoolAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentSchoolAssociation" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "studentSchoolAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/studentSchoolAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStudentSchoolAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.", - "in": "query", - "name": "studentFirstName", - "schema": { - "maxLength": 75, - "minLength": 1, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "$ref": "#/components/parameters/limit" }, { - "description": "The name borne in common by members of a family.", - "in": "query", - "name": "studentLastSurname", - "schema": { - "maxLength": 75, - "minLength": 1, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -3082,16 +4107,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation" + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3103,38 +4125,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentSchoolAssociations" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_HomographStudentSchoolAssociation", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/studentSchoolAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStudentSchoolAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the StudentSchoolAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentSchoolAssociation" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_StudentSchoolAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -3145,20 +4183,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentSchoolAssociations" ] @@ -3201,7 +4233,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3233,15 +4265,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -3268,7 +4291,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3325,7 +4348,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3603,6 +4626,69 @@ "studentLastSurname" ], "type": "object" + }, + "Homograph_Student_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Homograph_Student_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Homograph_Student_TrackedChangeKey": { + "properties": { + "studentFirstName": { + "maxLength": 75, + "minLength": 1, + "type": "string" + }, + "studentLastSurname": { + "maxLength": 75, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "studentFirstName", + "studentLastSurname" + ], + "type": "object" + }, + "Homograph_Student_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Homograph_Student_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Homograph_Student_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3695,7 +4781,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3738,7 +4824,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3758,6 +4844,124 @@ "x-Ed-Fi-domains": [ ] }, + "/homograph/students/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStudentsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Student_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "students" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/homograph/students/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_HomographStudentsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Homograph_Student_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "students" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/homograph/students/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -3793,7 +4997,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3825,15 +5029,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -3860,7 +5055,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3917,7 +5112,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" diff --git a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/sample-api-schema-authoritative.json b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/sample-api-schema-authoritative.json index 5526f9e66..f84801d67 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/sample-api-schema-authoritative.json +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/sample-api-schema-authoritative.json @@ -210,6 +210,67 @@ "shortDescription" ], "type": "object" + }, + "Sample_ArtMediumDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_ArtMediumDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_ArtMediumDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Sample_ArtMediumDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_ArtMediumDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_ArtMediumDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -326,7 +387,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -369,7 +430,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -389,6 +450,124 @@ "x-Ed-Fi-domains": [ ] }, + "/sample/artMediumDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleArtMediaDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_ArtMediumDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "artMediumDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/artMediumDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleArtMediaKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_ArtMediumDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "artMediumDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/sample/artMediumDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -424,7 +603,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -456,15 +635,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -491,7 +661,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -548,7 +718,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1435,6 +1605,67 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "Sample_BusRoute_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_BusRoute_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_BusRoute_TrackedChangeKey": { + "properties": { + "busId": { + "maxLength": 60, + "type": "string" + }, + "busRouteNumber": { + "format": "int32", + "type": "integer" + } + }, + "required": [ + "busId", + "busRouteNumber" + ], + "type": "object" + }, + "Sample_BusRoute_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_BusRoute_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_BusRoute_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -1644,7 +1875,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1687,7 +1918,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1707,27 +1938,40 @@ "x-Ed-Fi-domains": [ ] }, - "/sample/busRoutes/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_SampleBusRoutesById", + "/sample/busRoutes/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleBusRoutesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_BusRoute_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -1741,48 +1985,144 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "busRoutes" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/busRoutes/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_SampleBusRoutesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleBusRoutesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_BusRoute_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "busRoutes" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/busRoutes/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_SampleBusRoutesById", + "parameters": [ { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, "schema": { - "default": false, - "type": "boolean" + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "busRoutes" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_SampleBusRoutesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" } + }, + { + "$ref": "#/components/parameters/If-None-Match" } ], "responses": { @@ -1809,7 +2149,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1866,7 +2206,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2105,6 +2445,62 @@ "busId" ], "type": "object" + }, + "Sample_Bus_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_Bus_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_Bus_TrackedChangeKey": { + "properties": { + "busId": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "busId" + ], + "type": "object" + }, + "Sample_Bus_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_Bus_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_Bus_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -2175,7 +2571,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -2218,7 +2614,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2238,27 +2634,40 @@ "x-Ed-Fi-domains": [ ] }, - "/sample/buses/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_SampleBusesById", + "/sample/buses/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleBusesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_Bus_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2272,48 +2681,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "buses" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/buses/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_SampleBusesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleBusesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -2321,14 +2719,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Sample_Bus" + "items": { + "$ref": "#/components/schemas/Sample_Bus_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2340,20 +2738,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "buses" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "put_SampleBus", + "x-Ed-Fi-domains": [ + ] + }, + "/sample/buses/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_SampleBusesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -2368,18 +2770,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Sample_Bus" - } - } - }, - "description": "The JSON representation of the Bus resource to be created or updated.", - "required": true, - "x-bodyName": "Bus" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -2397,7 +2787,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -2409,7 +2799,122 @@ "$ref": "#/components/responses/Error" } }, - "summary": "Updates a resource based on the resource identifier.", + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "buses" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_SampleBusesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Sample_Bus" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "buses" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "put_SampleBus", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Sample_Bus" + } + } + }, + "description": "The JSON representation of the Bus resource to be created or updated.", + "required": true, + "x-bodyName": "Bus" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Updates a resource based on the resource identifier.", "tags": [ "buses" ] @@ -3661,6 +4166,67 @@ "shortDescription" ], "type": "object" + }, + "Sample_FavoriteBookCategoryDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_FavoriteBookCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_FavoriteBookCategoryDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Sample_FavoriteBookCategoryDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_FavoriteBookCategoryDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_FavoriteBookCategoryDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -3777,7 +4343,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3820,7 +4386,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3840,6 +4406,124 @@ "x-Ed-Fi-domains": [ ] }, + "/sample/favoriteBookCategoryDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleFavoriteBookCategoriesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_FavoriteBookCategoryDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "favoriteBookCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/favoriteBookCategoryDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleFavoriteBookCategoriesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_FavoriteBookCategoryDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "favoriteBookCategoryDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/sample/favoriteBookCategoryDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -3875,7 +4559,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -3907,15 +4591,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -3942,7 +4617,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -3999,7 +4674,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4226,6 +4901,67 @@ "shortDescription" ], "type": "object" + }, + "Sample_MembershipTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_MembershipTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Sample_MembershipTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -4306,13 +5042,124 @@ "x-Ed-Fi-isIdentity": true }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "membershipTypeDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_SampleMembershipType", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor" + } + } + }, + "description": "The JSON representation of the MembershipType resource to be created or updated.", + "required": true, + "x-bodyName": "MembershipType" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "membershipTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/membershipTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleMembershipTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -4321,16 +5168,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor" + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4342,38 +5186,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "membershipTypeDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_SampleMembershipType", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/sample/membershipTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleMembershipTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the MembershipType resource to be created or updated.", - "required": true, - "x-bodyName": "MembershipType" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_MembershipTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4384,20 +5244,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "membershipTypeDescriptors" ] @@ -4440,7 +5294,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4472,15 +5326,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -4507,7 +5352,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4564,7 +5409,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6218,6 +7063,87 @@ "style" ], "type": "object" + }, + "Sample_StudentArtProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_StudentArtProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programEducationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 60, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "beginDate", + "educationOrganizationId", + "programEducationOrganizationId", + "programName", + "programTypeDescriptor", + "studentUniqueId" + ], + "type": "object" + }, + "Sample_StudentArtProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -6417,21 +7343,132 @@ } }, { - "description": "The reason the student left the program within a school or district.", - "in": "query", - "name": "reasonExitedDescriptor", - "schema": { - "maxLength": 306, - "type": "string" - } + "description": "The reason the student left the program within a school or district.", + "in": "query", + "name": "reasonExitedDescriptor", + "schema": { + "maxLength": 306, + "type": "string" + } + }, + { + "description": "Indicates whether the student received services during the summer session or between sessions.", + "in": "query", + "name": "servedOutsideOfRegularSession", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "studentArtProgramAssociations" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_SampleStudentArtProgramAssociation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation" + } + } + }, + "description": "The JSON representation of the StudentArtProgramAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "StudentArtProgramAssociation" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "studentArtProgramAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/studentArtProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleStudentArtProgramAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" }, { - "description": "Indicates whether the student received services during the summer session or between sessions.", - "in": "query", - "name": "servedOutsideOfRegularSession", - "schema": { - "type": "boolean" - } + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -6440,16 +7477,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation" + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6461,38 +7495,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "studentArtProgramAssociations" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_SampleStudentArtProgramAssociation", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/sample/studentArtProgramAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleStudentArtProgramAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the StudentArtProgramAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "StudentArtProgramAssociation" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_StudentArtProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -6503,20 +7553,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "studentArtProgramAssociations" ] @@ -6559,7 +7603,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6591,15 +7635,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -6626,7 +7661,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6683,7 +7718,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9195,6 +10230,77 @@ ], "type": "object" }, + "Sample_StudentGraduationPlanAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Sample_StudentGraduationPlanAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Sample_StudentGraduationPlanAssociation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "graduationPlanTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "graduationSchoolYear": { + "format": "int32", + "type": "integer" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "graduationPlanTypeDescriptor", + "graduationSchoolYear", + "studentUniqueId" + ], + "type": "object" + }, + "Sample_StudentGraduationPlanAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Sample_StudentGraduationPlanAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Sample_StudentGraduationPlanAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" + }, "Sample_StudentGraduationPlanAssociation_YearsAttended": { "properties": { "yearsAttended": { @@ -9387,7 +10493,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9430,7 +10536,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9450,6 +10556,124 @@ "x-Ed-Fi-domains": [ ] }, + "/sample/studentGraduationPlanAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleStudentGraduationPlanAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_StudentGraduationPlanAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "studentGraduationPlanAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/sample/studentGraduationPlanAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_SampleStudentGraduationPlanAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Sample_StudentGraduationPlanAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "studentGraduationPlanAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/sample/studentGraduationPlanAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -9485,7 +10709,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9517,15 +10741,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -9552,7 +10767,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9609,7 +10824,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" diff --git a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/tpdm-api-schema-authoritative.json b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/tpdm-api-schema-authoritative.json index 05a232dad..930295a14 100644 --- a/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/tpdm-api-schema-authoritative.json +++ b/packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/tpdm-api-schema-authoritative.json @@ -263,6 +263,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_AccreditationStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_AccreditationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_AccreditationStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_AccreditationStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_AccreditationStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_AccreditationStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -379,7 +440,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -422,7 +483,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -442,6 +503,124 @@ "x-Ed-Fi-domains": [ ] }, + "/tpdm/accreditationStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMAccreditationStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_AccreditationStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "accreditationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/accreditationStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMAccreditationStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_AccreditationStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "accreditationStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/tpdm/accreditationStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -477,7 +656,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -509,15 +688,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -544,7 +714,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -601,7 +771,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -828,6 +998,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_AidTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_AidTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_AidTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_AidTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_AidTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_AidTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -944,7 +1175,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -987,7 +1218,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1007,27 +1238,40 @@ "x-Ed-Fi-domains": [ ] }, - "/tpdm/aidTypeDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_TPDMAidTypesById", + "/tpdm/aidTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMAidTypesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_AidTypeDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -1041,48 +1285,144 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "aidTypeDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/aidTypeDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_TPDMAidTypesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMAidTypesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_AidTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "aidTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/aidTypeDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_TPDMAidTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "aidTypeDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_TPDMAidTypesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" } + }, + { + "$ref": "#/components/parameters/If-None-Match" } ], "responses": { @@ -1109,7 +1449,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1166,7 +1506,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1767,6 +2107,84 @@ "programTypeDescriptor" ], "type": "object" + }, + "Tpdm_CandidateEducatorPreparationProgramAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_CandidateEducatorPreparationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_CandidateEducatorPreparationProgramAssociation_TrackedChangeKey": { + "properties": { + "beginDate": { + "format": "date", + "type": "string" + }, + "candidateIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "beginDate", + "candidateIdentifier", + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "Tpdm_CandidateEducatorPreparationProgramAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_CandidateEducatorPreparationProgramAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_CandidateEducatorPreparationProgramAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -1906,7 +2324,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -1949,7 +2367,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -1970,27 +2388,40 @@ "TeacherPreparation" ] }, - "/tpdm/candidateEducatorPreparationProgramAssociations/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_TPDMCandidateEducatorPreparationProgramAssociationsById", + "/tpdm/candidateEducatorPreparationProgramAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCandidateEducatorPreparationProgramAssociationsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_CandidateEducatorPreparationProgramAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2004,48 +2435,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "candidateEducatorPreparationProgramAssociations" ] }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/candidateEducatorPreparationProgramAssociations/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_TPDMCandidateEducatorPreparationProgramAssociationsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCandidateEducatorPreparationProgramAssociationsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -2053,14 +2474,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tpdm_CandidateEducatorPreparationProgramAssociation" + "items": { + "$ref": "#/components/schemas/Tpdm_CandidateEducatorPreparationProgramAssociation_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -2072,24 +2493,132 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "candidateEducatorPreparationProgramAssociations" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "put_TPDMCandidateEducatorPreparationProgramAssociation", - "parameters": [ - { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/candidateEducatorPreparationProgramAssociations/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_TPDMCandidateEducatorPreparationProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "candidateEducatorPreparationProgramAssociations" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_TPDMCandidateEducatorPreparationProgramAssociationsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_CandidateEducatorPreparationProgramAssociation" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "candidateEducatorPreparationProgramAssociations" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "put_TPDMCandidateEducatorPreparationProgramAssociation", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", "name": "id", "required": true, "schema": { @@ -2129,7 +2658,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4121,6 +4650,63 @@ "telephoneNumberTypeDescriptor" ], "type": "object" + }, + "Tpdm_Candidate_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_Candidate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_Candidate_TrackedChangeKey": { + "properties": { + "candidateIdentifier": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "candidateIdentifier" + ], + "type": "object" + }, + "Tpdm_Candidate_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_Candidate_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_Candidate_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -4426,7 +5012,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -4469,7 +5055,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -4490,27 +5076,40 @@ "TeacherPreparation" ] }, - "/tpdm/candidates/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_TPDMCandidatesById", + "/tpdm/candidates/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCandidatesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_Candidate_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4524,48 +5123,38 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "candidates" ] }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/candidates/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_TPDMCandidatesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCandidatesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -4573,14 +5162,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tpdm_Candidate" + "items": { + "$ref": "#/components/schemas/Tpdm_Candidate_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -4592,20 +5181,25 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "candidates" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "put_TPDMCandidate", + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/candidates/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_TPDMCandidatesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -4620,18 +5214,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_Candidate" - } - } - }, - "description": "The JSON representation of the Candidate resource to be created or updated.", - "required": true, - "x-bodyName": "Candidate" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -4649,7 +5231,122 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "candidates" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_TPDMCandidatesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_Candidate" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "candidates" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "put_TPDMCandidate", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_Candidate" + } + } + }, + "description": "The JSON representation of the Candidate resource to be created or updated.", + "required": true, + "x-bodyName": "Candidate" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5010,6 +5707,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_CertificationRouteDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_CertificationRouteDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_CertificationRouteDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -5126,7 +5884,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5169,7 +5927,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5189,27 +5947,40 @@ "x-Ed-Fi-domains": [ ] }, - "/tpdm/certificationRouteDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_TPDMCertificationRoutesById", + "/tpdm/certificationRouteDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCertificationRoutesDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -5223,48 +5994,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "certificationRouteDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/certificationRouteDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_TPDMCertificationRoutesById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCertificationRoutesKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -5272,14 +6032,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor" + "items": { + "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -5291,20 +6051,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "certificationRouteDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "put_TPDMCertificationRoute", + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/certificationRouteDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_TPDMCertificationRoutesById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -5319,15 +6083,118 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor" - } - } + "responses": { + "204": { + "$ref": "#/components/responses/Updated" }, - "description": "The JSON representation of the CertificationRoute resource to be created or updated.", + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Deletes an existing resource using the resource identifier.", + "tags": [ + "certificationRouteDescriptors" + ] + }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_TPDMCertificationRoutesById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "certificationRouteDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "put_TPDMCertificationRoute", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_CertificationRouteDescriptor" + } + } + }, + "description": "The JSON representation of the CertificationRoute resource to be created or updated.", "required": true, "x-bodyName": "CertificationRoute" }, @@ -5348,7 +6215,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5575,6 +6442,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_CoteachingStyleObservedDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_CoteachingStyleObservedDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_CoteachingStyleObservedDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -5691,7 +6619,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -5734,7 +6662,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5754,27 +6682,40 @@ "x-Ed-Fi-domains": [ ] }, - "/tpdm/coteachingStyleObservedDescriptors/{id}": { - "delete": { - "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", - "operationId": "delete_TPDMCoteachingStyleObservedsById", + "/tpdm/coteachingStyleObservedDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCoteachingStyleObservedsDeletes", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-Match" + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { - "204": { - "$ref": "#/components/responses/Updated" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -5788,48 +6729,37 @@ "404": { "$ref": "#/components/responses/NotFound" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" - }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Deletes an existing resource using the resource identifier.", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "coteachingStyleObservedDescriptors" ] }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/coteachingStyleObservedDescriptors/keyChanges": { "get": { - "description": "This GET operation retrieves a resource by the specified resource identifier.", - "operationId": "get_TPDMCoteachingStyleObservedsById", + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCoteachingStyleObservedsKeyChanges", "parameters": [ { - "description": "A resource identifier that uniquely identifies the resource.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/MinChangeVersion" }, { - "$ref": "#/components/parameters/If-None-Match" + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -5837,14 +6767,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor" + "items": { + "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor_TrackedChangeKeyChange" + }, + "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -5856,20 +6786,24 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "coteachingStyleObservedDescriptors" ] }, - "put": { - "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", - "operationId": "put_TPDMCoteachingStyleObserved", + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/coteachingStyleObservedDescriptors/{id}": { + "delete": { + "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", + "operationId": "delete_TPDMCoteachingStyleObservedsById", "parameters": [ { "description": "A resource identifier that uniquely identifies the resource.", @@ -5884,18 +6818,6 @@ "$ref": "#/components/parameters/If-Match" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor" - } - } - }, - "description": "The JSON representation of the CoteachingStyleObserved resource to be created or updated.", - "required": true, - "x-bodyName": "CoteachingStyleObserved" - }, "responses": { "204": { "$ref": "#/components/responses/Updated" @@ -5913,7 +6835,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -5925,15 +6847,130 @@ "$ref": "#/components/responses/Error" } }, - "summary": "Updates a resource based on the resource identifier.", + "summary": "Deletes an existing resource using the resource identifier.", "tags": [ "coteachingStyleObservedDescriptors" ] }, - "x-Ed-Fi-domains": [ - ] - } - }, + "get": { + "description": "This GET operation retrieves a resource by the specified resource identifier.", + "operationId": "get_TPDMCoteachingStyleObservedsById", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-None-Match" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves a specific resource using the resource's identifier (using the \"Get By Id\" pattern).", + "tags": [ + "coteachingStyleObservedDescriptors" + ] + }, + "put": { + "description": "The PUT operation is used to update a resource by identifier. If the resource identifier (\"id\") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.", + "operationId": "put_TPDMCoteachingStyleObserved", + "parameters": [ + { + "description": "A resource identifier that uniquely identifies the resource.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/If-Match" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_CoteachingStyleObservedDescriptor" + } + } + }, + "description": "The JSON representation of the CoteachingStyleObserved resource to be created or updated.", + "required": true, + "x-bodyName": "CoteachingStyleObserved" + }, + "responses": { + "204": { + "$ref": "#/components/responses/Updated" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Updates a resource based on the resource identifier.", + "tags": [ + "coteachingStyleObservedDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + } + }, "tags": [ { "description": "A type of co-teaching observed as part of the performance evaluation.", @@ -6140,6 +7177,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_CredentialStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_CredentialStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_CredentialStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_CredentialStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_CredentialStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_CredentialStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -6256,7 +7354,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6299,7 +7397,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6319,6 +7417,124 @@ "x-Ed-Fi-domains": [ ] }, + "/tpdm/credentialStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCredentialStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_CredentialStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "credentialStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/credentialStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMCredentialStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_CredentialStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "credentialStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/tpdm/credentialStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -6354,7 +7570,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -6386,15 +7602,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -6421,7 +7628,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -6478,7 +7685,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7184,6 +8391,73 @@ "programTypeDescriptor" ], "type": "object" + }, + "Tpdm_EducatorPreparationProgram_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EducatorPreparationProgram_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "programName": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "programTypeDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "programName", + "programTypeDescriptor" + ], + "type": "object" + }, + "Tpdm_EducatorPreparationProgram_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -7238,32 +8512,144 @@ "x-Ed-Fi-isIdentity": true }, { - "description": "The type of program.", - "in": "query", - "name": "programTypeDescriptor", - "schema": { - "maxLength": 306, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "description": "The type of program.", + "in": "query", + "name": "programTypeDescriptor", + "schema": { + "maxLength": 306, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "The current accreditation status of the Educator Preparation Program.", + "in": "query", + "name": "accreditationStatusDescriptor", + "schema": { + "maxLength": 306, + "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.", + "in": "query", + "name": "programId", + "schema": { + "maxLength": 20, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "educatorPreparationPrograms" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEducatorPreparationProgram", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram" + } + } + }, + "description": "The JSON representation of the EducatorPreparationProgram resource to be created or updated.", + "required": true, + "x-bodyName": "EducatorPreparationProgram" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "educatorPreparationPrograms" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/educatorPreparationPrograms/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEducatorPreparationProgramsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "The current accreditation status of the Educator Preparation Program.", - "in": "query", - "name": "accreditationStatusDescriptor", - "schema": { - "maxLength": 306, - "type": "string" - } + "$ref": "#/components/parameters/limit" }, { - "description": "A unique number or alphanumeric code assigned to a program by a school, school system, a state, or other agency or entity.", - "in": "query", - "name": "programId", - "schema": { - "maxLength": 20, - "type": "string" - } + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -7272,16 +8658,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram" + "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7293,38 +8676,55 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educatorPreparationPrograms" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEducatorPreparationProgram", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/educatorPreparationPrograms/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEducatorPreparationProgramsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EducatorPreparationProgram resource to be created or updated.", - "required": true, - "x-bodyName": "EducatorPreparationProgram" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EducatorPreparationProgram_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7335,20 +8735,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educatorPreparationPrograms" ] @@ -7392,7 +8786,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7424,15 +8818,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -7459,7 +8844,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -7516,7 +8901,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7741,6 +9126,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_EducatorRoleDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EducatorRoleDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_EducatorRoleDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -7811,23 +9257,134 @@ } }, { - "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", - "in": "query", - "name": "namespace", - "schema": { - "maxLength": 255, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", + "in": "query", + "name": "namespace", + "schema": { + "maxLength": 255, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "educatorRoleDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEducatorRole", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor" + } + } + }, + "description": "The JSON representation of the EducatorRole resource to be created or updated.", + "required": true, + "x-bodyName": "EducatorRole" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "educatorRoleDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/educatorRoleDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEducatorRolesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -7836,16 +9393,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor" + "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7857,38 +9411,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "educatorRoleDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEducatorRole", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/educatorRoleDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEducatorRolesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EducatorRole resource to be created or updated.", - "required": true, - "x-bodyName": "EducatorRole" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EducatorRoleDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -7899,20 +9469,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "educatorRoleDescriptors" ] @@ -7955,7 +9519,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -7987,15 +9551,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -8022,7 +9577,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8079,7 +9634,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8306,6 +9861,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_EnglishLanguageExamDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EnglishLanguageExamDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_EnglishLanguageExamDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -8367,32 +9983,143 @@ } }, { - "description": "The end date of the period when the descriptor is in effect.", - "in": "query", - "name": "effectiveEndDate", - "schema": { - "format": "date", - "type": "string" - } + "description": "The end date of the period when the descriptor is in effect.", + "in": "query", + "name": "effectiveEndDate", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", + "in": "query", + "name": "namespace", + "schema": { + "maxLength": 255, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "englishLanguageExamDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEnglishLanguageExam", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor" + } + } + }, + "description": "The JSON representation of the EnglishLanguageExam resource to be created or updated.", + "required": true, + "x-bodyName": "EnglishLanguageExam" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "englishLanguageExamDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/englishLanguageExamDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEnglishLanguageExamsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", - "in": "query", - "name": "namespace", - "schema": { - "maxLength": 255, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "$ref": "#/components/parameters/limit" }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -8401,16 +10128,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor" + "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -8422,38 +10146,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "englishLanguageExamDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEnglishLanguageExam", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/englishLanguageExamDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEnglishLanguageExamsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EnglishLanguageExam resource to be created or updated.", - "required": true, - "x-bodyName": "EnglishLanguageExam" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EnglishLanguageExamDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -8464,20 +10204,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "englishLanguageExamDescriptors" ] @@ -8520,7 +10254,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8552,15 +10286,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -8587,7 +10312,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -8644,7 +10369,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -8871,6 +10596,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_EppProgramPathwayDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EppProgramPathwayDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_EppProgramPathwayDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -8941,23 +10727,134 @@ } }, { - "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", - "in": "query", - "name": "namespace", - "schema": { - "maxLength": 255, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", + "in": "query", + "name": "namespace", + "schema": { + "maxLength": 255, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "eppProgramPathwayDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEPPProgramPathway", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor" + } + } + }, + "description": "The JSON representation of the EPPProgramPathway resource to be created or updated.", + "required": true, + "x-bodyName": "EPPProgramPathway" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "eppProgramPathwayDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/eppProgramPathwayDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEPPProgramPathwaysDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -8966,16 +10863,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor" + "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -8987,38 +10881,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "eppProgramPathwayDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEPPProgramPathway", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/eppProgramPathwayDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEPPProgramPathwaysKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EPPProgramPathway resource to be created or updated.", - "required": true, - "x-bodyName": "EPPProgramPathway" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EppProgramPathwayDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -9029,20 +10939,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "eppProgramPathwayDescriptors" ] @@ -9085,7 +10989,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9117,15 +11021,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -9152,7 +11047,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9209,7 +11104,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9436,6 +11331,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_EvaluationElementRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationElementRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_EvaluationElementRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -9551,39 +11507,163 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "evaluationElementRatingLevelDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEvaluationElementRatingLevel", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRatingLevelDescriptor" + } + } + }, + "description": "The JSON representation of the EvaluationElementRatingLevel resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationElementRatingLevel" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluationElementRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationElementRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationElementRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationElementRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationElementRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationElementRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" }, - "500": { - "$ref": "#/components/responses/Error" + { + "$ref": "#/components/parameters/totalCount" } - }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", - "tags": [ - "evaluationElementRatingLevelDescriptors" - ] - }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEvaluationElementRatingLevel", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EvaluationElementRatingLevelDescriptor" - } - } - }, - "description": "The JSON representation of the EvaluationElementRatingLevel resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationElementRatingLevel" - }, + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -9594,20 +11674,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationElementRatingLevelDescriptors" ] @@ -9650,7 +11724,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -9682,15 +11756,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -9717,7 +11782,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -9774,7 +11839,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10596,6 +12661,121 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "Tpdm_EvaluationElementRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationElementRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationDate": { + "format": "date-time", + "type": "string" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationDate", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_EvaluationElementRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -10808,16 +12988,125 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_EvaluationElementRating" + "$ref": "#/components/schemas/Tpdm_EvaluationElementRating" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "evaluationElementRatings" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEvaluationElementRating", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRating" + } + } + }, + "description": "The JSON representation of the EvaluationElementRating resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationElementRating" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluationElementRatings" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluationElementRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationElementRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRating_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -10829,38 +13118,55 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationElementRatings" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEvaluationElementRating", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EvaluationElementRating" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluationElementRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationElementRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EvaluationElementRating resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationElementRating" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationElementRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -10871,20 +13177,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationElementRatings" ] @@ -10928,7 +13228,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -10960,15 +13260,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -10995,7 +13286,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -11052,7 +13343,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -11693,6 +13984,106 @@ "evaluationObjectiveTitle" ], "type": "object" + }, + "Tpdm_EvaluationElement_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationElement_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_EvaluationElement_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElement_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationElement_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -11883,38 +14274,164 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "evaluationElements" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEvaluationElement", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EvaluationElement" + } + } + }, + "description": "The JSON representation of the EvaluationElement resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationElement" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluationElements" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluationElements/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationElementsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationElement_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationElements" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEvaluationElement", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EvaluationElement" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluationElements/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationElementsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EvaluationElement resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationElement" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationElement_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -11925,20 +14442,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationElements" ] @@ -11982,7 +14493,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -12014,15 +14525,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -12049,7 +14551,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -12106,7 +14608,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -12876,6 +15378,115 @@ "sourceSystemDescriptor" ], "type": "object" + }, + "Tpdm_EvaluationObjectiveRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjectiveRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationObjectiveRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationDate": { + "format": "date-time", + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationDate", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_EvaluationObjectiveRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjectiveRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjectiveRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -13068,38 +15679,164 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "evaluationObjectiveRatings" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEvaluationObjectiveRating", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjectiveRating" + } + } + }, + "description": "The JSON representation of the EvaluationObjectiveRating resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationObjectiveRating" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluationObjectiveRatings" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluationObjectiveRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationObjectiveRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjectiveRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationObjectiveRatings" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEvaluationObjectiveRating", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EvaluationObjectiveRating" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluationObjectiveRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationObjectiveRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EvaluationObjectiveRating resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationObjectiveRating" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjectiveRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -13110,20 +15847,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationObjectiveRatings" ] @@ -13167,7 +15898,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -13199,15 +15930,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -13234,7 +15956,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -13291,7 +16013,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -13904,6 +16626,100 @@ "evaluationObjectiveTitle" ], "type": "object" + }, + "Tpdm_EvaluationObjective_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationObjective_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_EvaluationObjective_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjective_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjective_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -14047,22 +16863,134 @@ } }, { - "description": "The minimum summary numerical rating or score for the evaluation Objective. If omitted, assumed to be 0.0.", - "in": "query", - "name": "minRating", - "schema": { - "format": "double", - "type": "number" - } + "description": "The minimum summary numerical rating or score for the evaluation Objective. If omitted, assumed to be 0.0.", + "in": "query", + "name": "minRating", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "The sort order of this Evaluation Objective.", + "in": "query", + "name": "sortOrder", + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjective" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "evaluationObjectives" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEvaluationObjective", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjective" + } + } + }, + "description": "The JSON representation of the EvaluationObjective resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationObjective" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluationObjectives" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluationObjectives/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationObjectivesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" }, { - "description": "The sort order of this Evaluation Objective.", - "in": "query", - "name": "sortOrder", - "schema": { - "format": "int32", - "type": "integer" - } + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -14071,16 +16999,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_EvaluationObjective" + "$ref": "#/components/schemas/Tpdm_EvaluationObjective_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -14092,38 +17017,55 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationObjectives" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEvaluationObjective", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EvaluationObjective" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluationObjectives/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationObjectivesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EvaluationObjective resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationObjective" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationObjective_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -14134,20 +17076,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationObjectives" ] @@ -14191,7 +17127,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14223,15 +17159,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -14258,7 +17185,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14315,7 +17242,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14595,6 +17522,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_EvaluationPeriodDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationPeriodDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_EvaluationPeriodDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -14647,41 +17635,152 @@ } }, { - "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", - "in": "query", - "name": "effectiveBeginDate", - "schema": { - "format": "date", - "type": "string" - } + "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", + "in": "query", + "name": "effectiveBeginDate", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "The end date of the period when the descriptor is in effect.", + "in": "query", + "name": "effectiveEndDate", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", + "in": "query", + "name": "namespace", + "schema": { + "maxLength": 255, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "evaluationPeriodDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEvaluationPeriod", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor" + } + } + }, + "description": "The JSON representation of the EvaluationPeriod resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationPeriod" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluationPeriodDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationPeriodDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationPeriodsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "The end date of the period when the descriptor is in effect.", - "in": "query", - "name": "effectiveEndDate", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/parameters/limit" }, { - "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", - "in": "query", - "name": "namespace", - "schema": { - "maxLength": 255, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "$ref": "#/components/parameters/offset" }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -14690,16 +17789,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor" + "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -14711,38 +17807,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationPeriodDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEvaluationPeriod", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationPeriodDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationPeriodsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EvaluationPeriod resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationPeriod" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationPeriodDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -14753,20 +17865,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationPeriodDescriptors" ] @@ -14809,7 +17915,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -14841,15 +17947,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -14876,7 +17973,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -14933,7 +18030,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15160,6 +18257,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_EvaluationRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_EvaluationRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -15276,7 +18434,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15318,20 +18476,138 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluationRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingLevelDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationRatingLevelDescriptors" ] @@ -15374,7 +18650,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15406,15 +18682,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -15441,7 +18708,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15498,7 +18765,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15725,6 +18992,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_EvaluationRatingStatusDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationRatingStatusDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_EvaluationRatingStatusDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingStatusDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingStatusDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -15841,7 +19169,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -15884,7 +19212,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15904,6 +19232,124 @@ "x-Ed-Fi-domains": [ ] }, + "/tpdm/evaluationRatingStatusDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationRatingStatusesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingStatusDescriptor_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationRatingStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationRatingStatusDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationRatingStatusesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationRatingStatusDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationRatingStatusDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/tpdm/evaluationRatingStatusDescriptors/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -15939,7 +19385,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -15971,15 +19417,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -16006,7 +19443,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -16063,7 +19500,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17017,8 +20454,111 @@ } }, "required": [ - "firstName", - "lastSurname" + "firstName", + "lastSurname" + ], + "type": "object" + }, + "Tpdm_EvaluationRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationDate": { + "format": "date-time", + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationDate", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_EvaluationRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" ], "type": "object" } @@ -17260,7 +20800,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17303,7 +20843,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17323,6 +20863,124 @@ "x-Ed-Fi-domains": [ ] }, + "/tpdm/evaluationRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationRating_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "evaluationRatings" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "evaluationRatings" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/tpdm/evaluationRatings/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -17358,7 +21016,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17390,15 +21048,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -17425,7 +21074,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -17482,7 +21131,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -17796,6 +21445,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_EvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_EvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_EvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -17891,16 +21601,124 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor" + "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "evaluationTypeDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEvaluationType", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor" + } + } + }, + "description": "The JSON representation of the EvaluationType resource to be created or updated.", + "required": true, + "x-bodyName": "EvaluationType" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -17912,38 +21730,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluationTypeDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEvaluationType", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/evaluationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the EvaluationType resource to be created or updated.", - "required": true, - "x-bodyName": "EvaluationType" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_EvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -17954,20 +21788,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluationTypeDescriptors" ] @@ -18010,7 +21838,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18042,15 +21870,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -18077,7 +21896,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -18134,7 +21953,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18669,6 +22488,94 @@ "termDescriptor" ], "type": "object" + }, + "Tpdm_Evaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_Evaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_Evaluation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_Evaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_Evaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_Evaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -18810,13 +22717,125 @@ } }, { - "description": "The minimum summary numerical rating or score for the evaluation. If omitted, assumed to be 0.0.", - "in": "query", - "name": "minRating", - "schema": { - "format": "double", - "type": "number" - } + "description": "The minimum summary numerical rating or score for the evaluation. If omitted, assumed to be 0.0.", + "in": "query", + "name": "minRating", + "schema": { + "format": "double", + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_Evaluation" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "evaluations" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMEvaluation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_Evaluation" + } + } + }, + "description": "The JSON representation of the Evaluation resource to be created or updated.", + "required": true, + "x-bodyName": "Evaluation" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "evaluations" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -18825,16 +22844,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_Evaluation" + "$ref": "#/components/schemas/Tpdm_Evaluation_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -18846,38 +22862,55 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "evaluations" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMEvaluation", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_Evaluation" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/evaluations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMEvaluationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the Evaluation resource to be created or updated.", - "required": true, - "x-bodyName": "Evaluation" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_Evaluation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -18888,20 +22921,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "evaluations" ] @@ -18945,7 +22972,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -18977,15 +23004,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -19012,7 +23030,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19069,7 +23087,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19449,6 +23467,72 @@ "studentUniqueId" ], "type": "object" + }, + "Tpdm_FinancialAid_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_FinancialAid_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_FinancialAid_TrackedChangeKey": { + "properties": { + "aidTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "beginDate": { + "format": "date", + "type": "string" + }, + "studentUniqueId": { + "maxLength": 32, + "type": "string" + } + }, + "required": [ + "aidTypeDescriptor", + "beginDate", + "studentUniqueId" + ], + "type": "object" + }, + "Tpdm_FinancialAid_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_FinancialAid_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_FinancialAid_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -19512,39 +23596,151 @@ "x-Ed-Fi-isIdentity": true }, { - "description": "The amount of financial aid awarded to a person for the term/year.", - "in": "query", - "name": "aidAmount", - "schema": { - "format": "double", - "type": "number" - } + "description": "The amount of financial aid awarded to a person for the term/year.", + "in": "query", + "name": "aidAmount", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "The description of the condition (e.g., placement in a high need school) under which the aid was given.", + "in": "query", + "name": "aidConditionDescription", + "schema": { + "maxLength": 1024, + "type": "string" + } + }, + { + "description": "The date the award was removed. Note: Date interpretation may vary. Ed-Fi recommends inclusive dates, but states may define dates as inclusive or exclusive. For calculations, align with local guidelines.", + "in": "query", + "name": "endDate", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "Indicates a person who receives Pell Grant aid.", + "in": "query", + "name": "pellGrantRecipient", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_FinancialAid" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "financialAids" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMFinancialAid", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_FinancialAid" + } + } + }, + "description": "The JSON representation of the FinancialAid resource to be created or updated.", + "required": true, + "x-bodyName": "FinancialAid" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "financialAids" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/financialAids/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMFinancialAidsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "The description of the condition (e.g., placement in a high need school) under which the aid was given.", - "in": "query", - "name": "aidConditionDescription", - "schema": { - "maxLength": 1024, - "type": "string" - } + "$ref": "#/components/parameters/limit" }, { - "description": "The date the award was removed. Note: Date interpretation may vary. Ed-Fi recommends inclusive dates, but states may define dates as inclusive or exclusive. For calculations, align with local guidelines.", - "in": "query", - "name": "endDate", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/parameters/offset" }, { - "description": "Indicates a person who receives Pell Grant aid.", - "in": "query", - "name": "pellGrantRecipient", - "schema": { - "type": "boolean" - } + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -19553,16 +23749,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_FinancialAid" + "$ref": "#/components/schemas/Tpdm_FinancialAid_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -19574,38 +23767,55 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "financialAids" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMFinancialAid", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_FinancialAid" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/financialAids/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMFinancialAidsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the FinancialAid resource to be created or updated.", - "required": true, - "x-bodyName": "FinancialAid" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_FinancialAid_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -19616,20 +23826,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "financialAids" ] @@ -19673,7 +23877,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -19705,15 +23909,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -19740,7 +23935,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -19797,7 +23992,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20031,6 +24226,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_GenderDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_GenderDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_GenderDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_GenderDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_GenderDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_GenderDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -20111,13 +24367,124 @@ "x-Ed-Fi-isIdentity": true }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_GenderDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "genderDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMGender", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_GenderDescriptor" + } + } + }, + "description": "The JSON representation of the Gender resource to be created or updated.", + "required": true, + "x-bodyName": "Gender" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "genderDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/genderDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMGendersDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -20126,16 +24493,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_GenderDescriptor" + "$ref": "#/components/schemas/Tpdm_GenderDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20147,38 +24511,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "genderDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMGender", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_GenderDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/genderDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMGendersKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the Gender resource to be created or updated.", - "required": true, - "x-bodyName": "Gender" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_GenderDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20189,20 +24569,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "genderDescriptors" ] @@ -20245,7 +24619,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20277,15 +24651,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -20312,7 +24677,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20369,7 +24734,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20596,6 +24961,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_ObjectiveRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_ObjectiveRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_ObjectiveRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -20639,50 +25065,161 @@ "x-Ed-Fi-isIdentity": true }, { - "description": "The description of the descriptor.", - "in": "query", - "name": "description", - "schema": { - "maxLength": 1024, - "type": "string" - } + "description": "The description of the descriptor.", + "in": "query", + "name": "description", + "schema": { + "maxLength": 1024, + "type": "string" + } + }, + { + "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", + "in": "query", + "name": "effectiveBeginDate", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "The end date of the period when the descriptor is in effect.", + "in": "query", + "name": "effectiveEndDate", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", + "in": "query", + "name": "namespace", + "schema": { + "maxLength": 255, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "objectiveRatingLevelDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMObjectiveRatingLevel", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor" + } + } + }, + "description": "The JSON representation of the ObjectiveRatingLevel resource to be created or updated.", + "required": true, + "x-bodyName": "ObjectiveRatingLevel" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "objectiveRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/objectiveRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMObjectiveRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, { - "description": "The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.", - "in": "query", - "name": "effectiveBeginDate", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "The end date of the period when the descriptor is in effect.", - "in": "query", - "name": "effectiveEndDate", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/parameters/limit" }, { - "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", - "in": "query", - "name": "namespace", - "schema": { - "maxLength": 255, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "$ref": "#/components/parameters/offset" }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -20691,16 +25228,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor" + "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20712,38 +25246,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "objectiveRatingLevelDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMObjectiveRatingLevel", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/objectiveRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMObjectiveRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the ObjectiveRatingLevel resource to be created or updated.", - "required": true, - "x-bodyName": "ObjectiveRatingLevel" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_ObjectiveRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -20754,20 +25304,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "objectiveRatingLevelDescriptors" ] @@ -20810,7 +25354,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -20842,15 +25386,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -20877,7 +25412,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -20934,7 +25469,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21161,6 +25696,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -21256,16 +25852,124 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor" + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "performanceEvaluationRatingLevelDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMPerformanceEvaluationRatingLevel", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor" + } + } + }, + "description": "The JSON representation of the PerformanceEvaluationRatingLevel resource to be created or updated.", + "required": true, + "x-bodyName": "PerformanceEvaluationRatingLevel" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "performanceEvaluationRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/performanceEvaluationRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMPerformanceEvaluationRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -21277,38 +25981,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "performanceEvaluationRatingLevelDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMPerformanceEvaluationRatingLevel", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/performanceEvaluationRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMPerformanceEvaluationRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the PerformanceEvaluationRatingLevel resource to be created or updated.", - "required": true, - "x-bodyName": "PerformanceEvaluationRatingLevel" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -21319,20 +26039,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "performanceEvaluationRatingLevelDescriptors" ] @@ -21375,7 +26089,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -21407,15 +26121,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -21442,7 +26147,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -21499,7 +26204,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22289,6 +26994,98 @@ "lastSurname" ], "type": "object" + }, + "Tpdm_PerformanceEvaluationRating_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_PerformanceEvaluationRating_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationPeriodDescriptor", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "personId", + "schoolYear", + "sourceSystemDescriptor", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_PerformanceEvaluationRating_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -22456,22 +27253,134 @@ } }, { - "description": "The rating level achieved based upon the rating or score.", - "in": "query", - "name": "performanceEvaluationRatingLevelDescriptor", - "schema": { - "maxLength": 306, - "type": "string" - } + "description": "The rating level achieved based upon the rating or score.", + "in": "query", + "name": "performanceEvaluationRatingLevelDescriptor", + "schema": { + "maxLength": 306, + "type": "string" + } + }, + { + "description": "The month, day, and year on which the performance evaluation was scheduled.", + "in": "query", + "name": "scheduleDate", + "schema": { + "format": "date", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "performanceEvaluationRatings" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMPerformanceEvaluationRating", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating" + } + } + }, + "description": "The JSON representation of the PerformanceEvaluationRating resource to be created or updated.", + "required": true, + "x-bodyName": "PerformanceEvaluationRating" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "performanceEvaluationRatings" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/performanceEvaluationRatings/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMPerformanceEvaluationRatingsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "The month, day, and year on which the performance evaluation was scheduled.", - "in": "query", - "name": "scheduleDate", - "schema": { - "format": "date", - "type": "string" - } + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -22480,16 +27389,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating" + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -22501,38 +27407,55 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "performanceEvaluationRatings" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMPerformanceEvaluationRating", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/performanceEvaluationRatings/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMPerformanceEvaluationRatingsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the PerformanceEvaluationRating resource to be created or updated.", - "required": true, - "x-bodyName": "PerformanceEvaluationRating" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationRating_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -22543,20 +27466,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "performanceEvaluationRatings" ] @@ -22600,7 +27517,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -22632,15 +27549,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -22667,7 +27575,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -22724,7 +27632,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23023,6 +27931,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_PerformanceEvaluationTypeDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_PerformanceEvaluationTypeDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_PerformanceEvaluationTypeDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -23084,32 +28053,143 @@ } }, { - "description": "The end date of the period when the descriptor is in effect.", - "in": "query", - "name": "effectiveEndDate", - "schema": { - "format": "date", - "type": "string" - } + "description": "The end date of the period when the descriptor is in effect.", + "in": "query", + "name": "effectiveEndDate", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", + "in": "query", + "name": "namespace", + "schema": { + "maxLength": 255, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "performanceEvaluationTypeDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMPerformanceEvaluationType", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor" + } + } + }, + "description": "The JSON representation of the PerformanceEvaluationType resource to be created or updated.", + "required": true, + "x-bodyName": "PerformanceEvaluationType" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "performanceEvaluationTypeDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/performanceEvaluationTypeDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMPerformanceEvaluationTypesDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" }, { - "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", - "in": "query", - "name": "namespace", - "schema": { - "maxLength": 255, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "$ref": "#/components/parameters/limit" }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -23118,16 +28198,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor" + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -23139,38 +28216,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "performanceEvaluationTypeDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMPerformanceEvaluationType", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/performanceEvaluationTypeDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMPerformanceEvaluationTypesKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the PerformanceEvaluationType resource to be created or updated.", - "required": true, - "x-bodyName": "PerformanceEvaluationType" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluationTypeDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -23181,20 +28274,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "performanceEvaluationTypeDescriptors" ] @@ -23237,7 +28324,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23269,15 +28356,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -23304,7 +28382,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -23361,7 +28439,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -23924,6 +29002,88 @@ "termDescriptor" ], "type": "object" + }, + "Tpdm_PerformanceEvaluation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_PerformanceEvaluation_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationPeriodDescriptor", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_PerformanceEvaluation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -24063,7 +29223,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24085,16 +29245,142 @@ } } }, - "description": "The JSON representation of the PerformanceEvaluation resource to be created or updated.", - "required": true, - "x-bodyName": "PerformanceEvaluation" - }, + "description": "The JSON representation of the PerformanceEvaluation resource to be created or updated.", + "required": true, + "x-bodyName": "PerformanceEvaluation" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "performanceEvaluations" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/performanceEvaluations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMPerformanceEvaluationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "performanceEvaluations" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/performanceEvaluations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMPerformanceEvaluationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_PerformanceEvaluation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -24105,20 +29391,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "performanceEvaluations" ] @@ -24162,7 +29442,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24194,15 +29474,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -24229,7 +29500,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -24286,7 +29557,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -24762,6 +30033,111 @@ "rubricRating" ], "type": "object" + }, + "Tpdm_RubricDimension_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_RubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_RubricDimension_TrackedChangeKey": { + "properties": { + "educationOrganizationId": { + "format": "int64", + "type": "integer" + }, + "evaluationElementTitle": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "evaluationObjectiveTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "evaluationPeriodDescriptor": { + "maxLength": 306, + "type": "string" + }, + "evaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTitle": { + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "performanceEvaluationTypeDescriptor": { + "maxLength": 306, + "type": "string" + }, + "rubricRating": { + "format": "int32", + "type": "integer" + }, + "schoolYear": { + "format": "int32", + "type": "integer" + }, + "termDescriptor": { + "maxLength": 306, + "type": "string" + } + }, + "required": [ + "educationOrganizationId", + "evaluationElementTitle", + "evaluationObjectiveTitle", + "evaluationPeriodDescriptor", + "evaluationTitle", + "performanceEvaluationTitle", + "performanceEvaluationTypeDescriptor", + "rubricRating", + "schoolYear", + "termDescriptor" + ], + "type": "object" + }, + "Tpdm_RubricDimension_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_RubricDimension_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_RubricDimension_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -24899,31 +30275,143 @@ "x-Ed-Fi-isIdentity": true }, { - "description": "The criterion description for the rubric dimension.", - "in": "query", - "name": "criterionDescription", - "schema": { - "maxLength": 1024, - "type": "string" - } + "description": "The criterion description for the rubric dimension.", + "in": "query", + "name": "criterionDescription", + "schema": { + "maxLength": 1024, + "type": "string" + } + }, + { + "description": "The order for the rubric dimension.", + "in": "query", + "name": "dimensionOrder", + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "description": "The rating level achieved for the rubric dimension.", + "in": "query", + "name": "rubricRatingLevelDescriptor", + "schema": { + "maxLength": 306, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_RubricDimension" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "rubricDimensions" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMRubricDimension", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_RubricDimension" + } + } + }, + "description": "The JSON representation of the RubricDimension resource to be created or updated.", + "required": true, + "x-bodyName": "RubricDimension" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "rubricDimensions" + ] + }, + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/rubricDimensions/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMRubricDimensionsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" }, { - "description": "The order for the rubric dimension.", - "in": "query", - "name": "dimensionOrder", - "schema": { - "format": "int32", - "type": "integer" - } + "$ref": "#/components/parameters/offset" }, { - "description": "The rating level achieved for the rubric dimension.", - "in": "query", - "name": "rubricRatingLevelDescriptor", - "schema": { - "maxLength": 306, - "type": "string" - } + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -24932,16 +30420,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_RubricDimension" + "$ref": "#/components/schemas/Tpdm_RubricDimension_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -24953,38 +30438,55 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "rubricDimensions" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMRubricDimension", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_RubricDimension" - } - } + "x-Ed-Fi-domains": [ + "TeacherPreparation" + ] + }, + "/tpdm/rubricDimensions/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMRubricDimensionsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the RubricDimension resource to be created or updated.", - "required": true, - "x-bodyName": "RubricDimension" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_RubricDimension_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -24995,20 +30497,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "rubricDimensions" ] @@ -25052,7 +30548,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25084,15 +30580,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -25119,7 +30606,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25176,7 +30663,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25449,6 +30936,67 @@ "shortDescription" ], "type": "object" + }, + "Tpdm_RubricRatingLevelDescriptor_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_RubricRatingLevelDescriptor_TrackedChangeKey": { + "properties": { + "codeValue": { + "maxLength": 50, + "type": "string" + }, + "namespace": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "codeValue" + ], + "type": "object" + }, + "Tpdm_RubricRatingLevelDescriptor_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -25519,23 +31067,134 @@ } }, { - "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", - "in": "query", - "name": "namespace", - "schema": { - "maxLength": 255, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "description": "A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.", + "in": "query", + "name": "namespace", + "schema": { + "maxLength": 255, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + }, + { + "description": "A shortened description for the descriptor.", + "in": "query", + "name": "shortDescription", + "schema": { + "maxLength": 75, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "rubricRatingLevelDescriptors" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMRubricRatingLevel", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor" + } + } + }, + "description": "The JSON representation of the RubricRatingLevel resource to be created or updated.", + "required": true, + "x-bodyName": "RubricRatingLevel" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "rubricRatingLevelDescriptors" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/rubricRatingLevelDescriptors/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMRubricRatingLevelsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" }, { - "description": "A shortened description for the descriptor.", - "in": "query", - "name": "shortDescription", - "schema": { - "maxLength": 75, - "type": "string" - } + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -25544,16 +31203,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor" + "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -25565,38 +31221,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "rubricRatingLevelDescriptors" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMRubricRatingLevel", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/rubricRatingLevelDescriptors/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMRubricRatingLevelsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the RubricRatingLevel resource to be created or updated.", - "required": true, - "x-bodyName": "RubricRatingLevel" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_RubricRatingLevelDescriptor_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -25607,20 +31279,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "rubricRatingLevelDescriptors" ] @@ -25663,7 +31329,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -25695,15 +31361,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -25730,7 +31387,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -25787,7 +31444,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26211,6 +31868,83 @@ "surveyResponseIdentifier" ], "type": "object" + }, + "Tpdm_SurveyResponsePersonTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_SurveyResponsePersonTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + } + }, + "required": [ + "namespace", + "personId", + "sourceSystemDescriptor", + "surveyIdentifier", + "surveyResponseIdentifier" + ], + "type": "object" + }, + "Tpdm_SurveyResponsePersonTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -26285,14 +32019,125 @@ "x-Ed-Fi-isIdentity": true }, { - "description": "The identifier of the survey typically from the survey application.", - "in": "query", - "name": "surveyResponseIdentifier", - "schema": { - "maxLength": 60, - "type": "string" - }, - "x-Ed-Fi-isIdentity": true + "description": "The identifier of the survey typically from the survey application.", + "in": "query", + "name": "surveyResponseIdentifier", + "schema": { + "maxLength": 60, + "type": "string" + }, + "x-Ed-Fi-isIdentity": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation" + }, + "type": "array" + } + } + }, + "description": "The requested resource was successfully retrieved." + }, + "304": { + "$ref": "#/components/responses/NotModified" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "tags": [ + "surveyResponsePersonTargetAssociations" + ] + }, + "post": { + "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", + "operationId": "post_TPDMSurveyResponsePersonTargetAssociation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation" + } + } + }, + "description": "The JSON representation of the SurveyResponsePersonTargetAssociation resource to be created or updated.", + "required": true, + "x-bodyName": "SurveyResponsePersonTargetAssociation" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Updated" + }, + "201": { + "$ref": "#/components/responses/Created" + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "405": { + "description": "Method Is Not Allowed." + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "412": { + "$ref": "#/components/responses/PreconditionFailed" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "tags": [ + "surveyResponsePersonTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/surveyResponsePersonTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMSurveyResponsePersonTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" } ], "responses": { @@ -26301,16 +32146,13 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation" + "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation_TrackedChangeDelete" }, "type": "array" } } }, - "description": "The requested resource was successfully retrieved." - }, - "304": { - "$ref": "#/components/responses/NotModified" + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -26322,38 +32164,54 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Retrieves specific resources using the resource's property values (using the \"Get\" pattern).", + "summary": "Retrieves deleted resource keys for Change Queries.", "tags": [ "surveyResponsePersonTargetAssociations" ] }, - "post": { - "description": "The POST operation can be used to create or update resources. In database terms, this is often referred to as an \"upsert\" operation (insert + update). Clients should NOT include the resource \"id\" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.", - "operationId": "post_TPDMSurveyResponsePersonTargetAssociation", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation" - } - } + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/surveyResponsePersonTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMSurveyResponsePersonTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" }, - "description": "The JSON representation of the SurveyResponsePersonTargetAssociation resource to be created or updated.", - "required": true, - "x-bodyName": "SurveyResponsePersonTargetAssociation" - }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], "responses": { "200": { - "$ref": "#/components/responses/Updated" - }, - "201": { - "$ref": "#/components/responses/Created" + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_SurveyResponsePersonTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." }, "400": { "$ref": "#/components/responses/BadRequest" @@ -26364,20 +32222,14 @@ "403": { "$ref": "#/components/responses/Forbidden" }, - "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." - }, - "409": { - "$ref": "#/components/responses/Conflict" - }, - "412": { - "$ref": "#/components/responses/PreconditionFailed" + "404": { + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" } }, - "summary": "Creates or updates resources based on the natural key values of the supplied resource.", + "summary": "Retrieves changed resource keys for Change Queries.", "tags": [ "surveyResponsePersonTargetAssociations" ] @@ -26420,7 +32272,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -26452,15 +32304,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -26487,7 +32330,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -26544,7 +32387,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27003,6 +32846,88 @@ "surveySectionTitle" ], "type": "object" + }, + "Tpdm_SurveySectionResponsePersonTargetAssociation_TrackedChangeDelete": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "keyValues": { + "$ref": "#/components/schemas/Tpdm_SurveySectionResponsePersonTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "keyValues" + ], + "type": "object" + }, + "Tpdm_SurveySectionResponsePersonTargetAssociation_TrackedChangeKey": { + "properties": { + "namespace": { + "maxLength": 255, + "minLength": 5, + "type": "string" + }, + "personId": { + "maxLength": 32, + "type": "string" + }, + "sourceSystemDescriptor": { + "maxLength": 306, + "type": "string" + }, + "surveyIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveyResponseIdentifier": { + "maxLength": 60, + "type": "string" + }, + "surveySectionTitle": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "namespace", + "personId", + "sourceSystemDescriptor", + "surveyIdentifier", + "surveyResponseIdentifier", + "surveySectionTitle" + ], + "type": "object" + }, + "Tpdm_SurveySectionResponsePersonTargetAssociation_TrackedChangeKeyChange": { + "properties": { + "changeVersion": { + "format": "int64", + "type": "integer" + }, + "id": { + "type": "string" + }, + "newKeyValues": { + "$ref": "#/components/schemas/Tpdm_SurveySectionResponsePersonTargetAssociation_TrackedChangeKey" + }, + "oldKeyValues": { + "$ref": "#/components/schemas/Tpdm_SurveySectionResponsePersonTargetAssociation_TrackedChangeKey" + } + }, + "required": [ + "id", + "changeVersion", + "oldKeyValues", + "newKeyValues" + ], + "type": "object" } } }, @@ -27124,7 +33049,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27167,7 +33092,7 @@ "$ref": "#/components/responses/Forbidden" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27187,6 +33112,124 @@ "x-Ed-Fi-domains": [ ] }, + "/tpdm/surveySectionResponsePersonTargetAssociations/deletes": { + "get": { + "description": "This GET operation provides access to deleted resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMSurveySectionResponsePersonTargetAssociationsDeletes", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_SurveySectionResponsePersonTargetAssociation_TrackedChangeDelete" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves deleted resource keys for Change Queries.", + "tags": [ + "surveySectionResponsePersonTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, + "/tpdm/surveySectionResponsePersonTargetAssociations/keyChanges": { + "get": { + "description": "This GET operation provides access to changed resource keys in the requested ChangeVersion range.", + "operationId": "get_TPDMSurveySectionResponsePersonTargetAssociationsKeyChanges", + "parameters": [ + { + "$ref": "#/components/parameters/MinChangeVersion" + }, + { + "$ref": "#/components/parameters/MaxChangeVersion" + }, + { + "$ref": "#/components/parameters/limit" + }, + { + "$ref": "#/components/parameters/offset" + }, + { + "$ref": "#/components/parameters/totalCount" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Tpdm_SurveySectionResponsePersonTargetAssociation_TrackedChangeKeyChange" + }, + "type": "array" + } + } + }, + "description": "The requested Change Query results were successfully retrieved." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "500": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Retrieves changed resource keys for Change Queries.", + "tags": [ + "surveySectionResponsePersonTargetAssociations" + ] + }, + "x-Ed-Fi-domains": [ + ] + }, "/tpdm/surveySectionResponsePersonTargetAssociations/{id}": { "delete": { "description": "The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found).", @@ -27222,7 +33265,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict" @@ -27254,15 +33297,6 @@ }, { "$ref": "#/components/parameters/If-None-Match" - }, - { - "description": "Indicates if the configured Snapshot should be used.", - "in": "header", - "name": "Use-Snapshot", - "schema": { - "default": false, - "type": "boolean" - } } ], "responses": { @@ -27289,7 +33323,7 @@ "$ref": "#/components/responses/Forbidden" }, "404": { - "$ref": "#/components/responses/NotFoundUseSnapshot" + "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/Error" @@ -27346,7 +33380,7 @@ "$ref": "#/components/responses/NotFound" }, "405": { - "description": "Method Is Not Allowed. When the Use-Snapshot header is set to true, the method is not allowed." + "description": "Method Is Not Allowed." }, "409": { "$ref": "#/components/responses/Conflict"